-
Notifications
You must be signed in to change notification settings - Fork 2k
/
EntityContract.java
112 lines (101 loc) · 3.41 KB
/
EntityContract.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.microsoft.windowsazure.services.media.entityoperations;
import com.microsoft.windowsazure.services.core.ServiceException;
import com.microsoft.windowsazure.services.media.models.ListResult;
/**
* Contract for interacting with the back end service
* providing various odata entities.
*
*/
public interface EntityContract {
/**
* Create a new instance of an entity.
*
* @param <T>
* the generic type
* @param creator
* Object providing the details of the entity to be
* created
* @return the t
* @throws ServiceException
* the service exception
* The created entity
*/
public abstract <T> T create(EntityCreateOperation<T> creator) throws ServiceException;
/**
* Retrieve an existing entity by id.
*
* @param <T>
* the generic type
* @param getter
* object providing the details of the entity to be retrieved
* @return The retrieved entity
* @throws ServiceException
* the service exception
*/
public abstract <T> T get(EntityGetOperation<T> getter) throws ServiceException;
/**
* Retrieve a list of entities.
*
* @param <T>
* the generic type
* @param lister
* object providing details of entities to list
* @return The resulting list
* @throws ServiceException
* the service exception
*/
public abstract <T> ListResult<T> list(EntityListOperation<T> lister) throws ServiceException;
/**
* Update an existing entity.
*
* @param updater
* Object providing details of the update
* @throws ServiceException
* the service exception
*/
public abstract void update(EntityUpdateOperation updater) throws ServiceException;
/**
* Delete an entity.
*
* @param deleter
* Object providing details of the delete
* @throws ServiceException
* the service exception
*/
public abstract void delete(EntityDeleteOperation deleter) throws ServiceException;
/**
* Perform an action on an entity.
*
* @param action
* Object providing details of the action
* @throws ServiceException
* the service exception
*/
public abstract void action(EntityActionOperation action) throws ServiceException;
/**
* Action.
*
* @param <T>
* the generic type
* @param entityActionOperation
* the entity action operation
* @return the t
* @throws ServiceException
* the service exception
*/
public abstract <T> T action(EntityTypeActionOperation<T> entityActionOperation) throws ServiceException;
}