public interface Resource extends CentraSiteRegistryObject
Modifier and Type | Method and Description |
---|---|
java.util.List<CentraSiteFile> |
getDocuments()
Get the list of documents attached for this resource.
|
java.util.Set<java.lang.String> |
getHttpMethods()
Gets the HTTP methods supported by this resource.
|
java.util.Collection<RESTMethod> |
getMethods()
Gets the list of methods defined on the resource
|
java.util.Collection<java.lang.Object> |
getNestedResources()
Gets the nested resources of the resource.
|
java.lang.String |
getODataEntityType()
Gets the OData entity type of the resource.
|
Category |
getODataResourceType()
Gets the OData resource type of the resource.
|
java.util.Collection<RESTParameter> |
getParameters()
Gets the parameters of the resource
|
java.lang.String |
getPath()
Retrieves the path value of the designated resource.
|
java.util.Set<java.lang.String> |
getQueryStrings()
Get the query strings for this resource.
|
java.util.Collection<java.lang.String> |
getResourceURLs()
Returns list of URLs using which the resource can be accessed.
|
java.lang.String |
getSchemaAccessUrl(java.lang.String schemaId)
Get the schema access URL for the resource.
|
java.lang.String |
getSchemaId()
Get the UUID for the attached schema for the resource.
|
AbstractXMLService |
getService()
Gets the REST/XML service to which the resource is belongs to.
|
java.util.Collection<java.lang.Object> |
getSupportedMethods()
Gets the REST methods supported by the resource.
|
java.util.List<CentraSiteRegistryObject> |
getXmlSchemas()
Get the XML schemas attached to the resource.
|
void |
setDocuments(java.util.List<CentraSiteFile> documents)
Set the documents to be attached to the resource.
|
void |
setId(java.lang.String id)
Set the UUID key for the resource.
|
void |
setMethods(java.util.Collection<RESTMethod> restMethods)
Defines a set of methods for the designated resource.
|
void |
setNestedResource(java.util.Collection<java.lang.Object> nestedResources)
Gets the nested resources of the resource.
|
void |
setODataEntityType(java.lang.String odataEntityType)
Sets the OData entity type of the resource.
|
void |
setODataResourceType(Category odataResourceType)
Sets the OData resource type of the resource.
|
void |
setParameters(java.util.Collection<RESTParameter> restParameters)
Defines a collection of parameters for the designated resource.
|
void |
setPath(java.lang.String path)
Defines a path value for the designated resource.
|
void |
setQueryStrings(java.util.Set<java.lang.String> queryStrings)
Set the query strings for this resource.
|
void |
setSchemaId(java.lang.String schemaId)
Set the schema id for the resource.
|
void |
setService(AbstractXMLService service)
Sets the REST/XML service to the resource.
|
void |
setSupportedMethods(java.util.Collection<java.lang.Object> supportedMethods)
Sets the REST methods supported by the resource.
|
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
void setId(java.lang.String id)
id
- The resource id to setjava.util.Set<java.lang.String> getHttpMethods() throws CLLException
Set
of the HTTP methods supported by the resourceCLLException
- If an error occurs while accessing the datajava.util.Set<java.lang.String> getQueryStrings() throws CLLException
Set
of query strings for this resourceCLLException
- If an error occurs while trying to get the query stringsvoid setQueryStrings(java.util.Set<java.lang.String> queryStrings) throws CLLException
queryStrings
- The query strings to setCLLException
- If an error occurs while trying to set the query stringsjava.lang.String getSchemaId()
void setSchemaId(java.lang.String schemaId) throws CLLException
schemaId
- The schema id to set for the resourceCLLException
- If an error occurs while trying to set the XML Schema object to the Resourcejava.util.List<CentraSiteFile> getDocuments() throws CLLException
List
of CentraSiteFile
documents attached for this resourceCLLException
- If an error occurs while trying to fetch the documentsvoid setDocuments(java.util.List<CentraSiteFile> documents) throws CLLException
documents
- The List
of documents to attach to the resourceCLLException
- If an error occurs while trying to set the documentsjava.util.List<CentraSiteRegistryObject> getXmlSchemas() throws CLLException
List
of CentraSiteRegistryObject
instancesCLLException
- If an error occurs while trying to get the XML schemasjava.lang.String getSchemaAccessUrl(java.lang.String schemaId) throws CLLException
schemaId
- The schema id for the XML schemaCLLException
- If an error occurs while trying to get the schema access URL.void setPath(java.lang.String path) throws CLLException
path
- The path value of the resourceCLLException
- If an error occurs while trying to set the path value for the resource.java.lang.String getPath() throws CLLException
CLLException
- If an error occurs while trying to fetch the path of the resource.java.util.Collection<java.lang.String> getResourceURLs() throws CLLException
Collection
of String
.The list of URL values for the resource.CLLException
- If an error occurs while fetching the URLs of the resource.void setMethods(java.util.Collection<RESTMethod> restMethods) throws CLLException
restMethods
- The Collection
of RESTMethod
objects.CLLException
- If an error occurs while trying to set the method objects to the resource.java.util.Collection<RESTMethod> getMethods() throws CLLException
Collection
of RESTMethods
defined on the resource.CLLException
- If an error occurs while setting the methods for the resource.void setParameters(java.util.Collection<RESTParameter> restParameters) throws CLLException
restParameters
- The Collection
of RESTParameter
to be set on the resource.CLLException
- If an error occurs while setting the parameters for the resource.java.util.Collection<RESTParameter> getParameters() throws CLLException
Collection
of RESTParameter
associated to the resource.CLLException
- If an error occurs while fetching the parameters of the resource.void setService(AbstractXMLService service)
service
- The AbstractXMLService
.AbstractXMLService getService()
AbstractXMLService
of the resource.Category getODataResourceType() throws CLLException
CLLException
void setODataResourceType(Category odataResourceType) throws CLLException
odataResourceType
- The OData resource typeCLLException
java.lang.String getODataEntityType() throws CLLException
CLLException
void setODataEntityType(java.lang.String odataEntityType) throws CLLException
odataEntityType
- The OData entity typeCLLException
java.util.Collection<java.lang.Object> getSupportedMethods() throws CLLException
CLLException
void setSupportedMethods(java.util.Collection<java.lang.Object> supportedMethods) throws CLLException
supportedMethods
- The REST methods supported by the resource.CLLException
java.util.Collection<java.lang.Object> getNestedResources() throws CLLException
CLLException
void setNestedResource(java.util.Collection<java.lang.Object> nestedResources) throws CLLException
CLLException