public interface RESTSchema extends CentraSiteRegistryObject
RESTSchema
represents the RESTSchema details of an API as below.
Modifier and Type | Method and Description |
---|---|
java.util.List<javax.xml.registry.infomodel.ExternalLink> |
getExternalLinks()
Gets the RESTSchema files and its content that are defined for the parameter or media type object.
|
java.util.Collection<RESTSchema> |
getReferenceSchemas()
Gets the list of nested schemas defined on the schema
|
java.lang.String |
getSchemaContent()
Returns the RESTSchema properties of the RESTSchema object.
|
java.lang.String |
getSchemaType()
Returns the RESTSchema type of the RESTSchema object.
|
AbstractXMLService |
getService()
Gets the REST service.
|
java.lang.Boolean |
isArray()
Tells whether the RESTSchema can hold multiple values or not.
|
void |
setArray(java.lang.Boolean value)
Sets the multiplicity characteristic of the RESTSchema.
|
void |
setExternalLinks(java.util.List<javax.xml.registry.infomodel.ExternalLink> externalLinks)
Sets the RESTSchema files and its content that are defined for the parameter or media type object.
|
void |
setReferenceSchemas(java.util.Collection<RESTSchema> schemas)
Defines a set of nested schemas for the designated schema.
|
void |
setSchemaContent(java.lang.String content)
Sets the RESTSchema content of the RESTSchema object.
|
void |
setSchemaType(java.lang.String type)
Sets the RESTSchema type of the RESTSchema object.
|
void |
setService(AbstractXMLService service)
Sets the REST service .
|
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
java.util.List<javax.xml.registry.infomodel.ExternalLink> getExternalLinks() throws CLLException
List
CLLException
- If error occurs while fetching the files of the RESTSchema object.void setExternalLinks(java.util.List<javax.xml.registry.infomodel.ExternalLink> externalLinks) throws CLLException
{@link
- ListCLLException
- If error occurs while setting the RESTSchema content files to parameter or media type object.java.lang.Boolean isArray() throws CLLException
CLLException
void setArray(java.lang.Boolean value) throws CLLException
isArray
- true if the RESTSchema can hold multiple values; otherwise false.CLLException
- If an error occurs while setting the 'multiplicity' characteristic of the RESTSchema.java.lang.String getSchemaType() throws CLLException
ParameterType
String
; the RESTSchema type of the RESTSchema object.CLLException
- If an error occurs while fetching the RESTSchema type of the RESTSchema.void setSchemaType(java.lang.String type) throws CLLException
type
- The RESTSchema type as String
CLLException
- If an error occurs while setting the RESTSchema type for the RESTSchema.java.util.Collection<RESTSchema> getReferenceSchemas() throws CLLException
Collection
of RESTSchema
defined on the schema.CLLException
- If an error occurs while setting the nested schemas for the schema.void setReferenceSchemas(java.util.Collection<RESTSchema> schemas) throws CLLException
schemas
- The List
of RESTSchema
schema.CLLException
- If an error occurs while trying to set the nested schema objects to the schema.java.lang.String getSchemaContent() throws CLLException
String
; the RESTSchema properties of the RESTSchema object.CLLException
- If an error occurs while fetching the RESTSchema properties of the RESTSchema.void setSchemaContent(java.lang.String content) throws CLLException
type
- The RESTSchema content as String
CLLException
- If an error occurs while setting the RESTSchema properties for the RESTSchema.void setService(AbstractXMLService service)
service
- The AbstractXMLService
.AbstractXMLService getService()
AbstractXMLService
of the resource.