public interface TypeDescription
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(AttributeDescription attribute)
Adds the given attribute metadata to the given object type.
|
void |
addMandatoryProfiles()
Adds the mandatory for the CentraSite UI profiles to this type.
|
void |
addProfile(Profile profile)
Adds the given profile to the object type.
|
AttributeDescription |
getAttributeByName(java.lang.String name)
Gets attributes list assigned to the object type.
|
java.util.Collection<AttributeDescription> |
getAttributes()
Gets attributes list assigned to the object type.
|
java.lang.String |
getConceptKey()
Get associated concept key.
|
java.lang.String |
getDescription()
Get the type description.
|
java.lang.String |
getDisplayName()
Get the type's display name.
|
java.lang.String |
getIconUrl()
Get the link to the type icon.
|
java.lang.String |
getLargeIconUrl()
Get the url to the LargeTypeIcon.
|
java.lang.String |
getLocalPart()
Derive local part from complete name.
|
java.lang.String |
getName()
Get the type name.
|
java.lang.String |
getNamespaceUri()
Derive namespace from complete name.
|
Profile |
getProfile(java.lang.String name)
Gets a profile of an object type for a given name.
|
java.util.Collection<Profile> |
getProfiles()
Gets the profiles list of an object type.
|
boolean |
isExtensible()
Deprecated.
types are always extensible, method always returns true
|
void |
removeAttribute(AttributeDescription attribute)
Removes the selected attribute from the object type.
|
void |
removeProfile(Profile profile)
Removes the given profile from the object type definition.
|
void |
setDescription(java.lang.String description)
Set the type description.
|
void |
setDisplayName(java.lang.String name)
Set the type's display name.
|
void |
setExtensible(boolean extensible)
Deprecated.
types are always extensible
|
void |
setIconInputStream(java.io.InputStream iconInputStream)
Set the input stream representing the type icon.
|
void |
setIconMediaType(java.lang.String iconMediaType)
Set the media type of the type icon.
|
void |
setIconUrl(java.lang.String iconUrl)
Set the link to the type icon.
|
void |
setLargeIconInputStream(java.io.InputStream largeIconInputStream)
Set the input stream representing the large type icon.
|
void |
setLargeIconMediaType(java.lang.String largeIconMediaType)
Set the media type of the large type icon.
|
void |
setLargeIconUrl(java.lang.String largeIconUrl)
Set the url to the LargeTypeIcon.
|
void |
setLocalPart(java.lang.String part)
Set local part in complete name.
|
void |
setName(java.lang.String name)
Set the type name.
|
void |
setNamespaceUri(java.lang.String namespaceUri)
Set namespace in complete name.
|
void setName(java.lang.String name) throws CSAppFrameworkException
name
- name in the form "{uri}local-name".CSAppFrameworkException
- if an internal error occurs.java.lang.String getName()
void setDisplayName(java.lang.String name) throws CSAppFrameworkException
name
- the type's display name.CSAppFrameworkException
- if an internal error occurs.java.lang.String getDisplayName() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.void setNamespaceUri(java.lang.String namespaceUri)
namespaceUri
- namespace URI.java.lang.String getNamespaceUri()
void setLocalPart(java.lang.String part)
part
- local partjava.lang.String getLocalPart()
java.lang.String getConceptKey() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.void setDescription(java.lang.String description)
description
- description of typejava.lang.String getDescription()
void setExtensible(boolean extensible)
extensible
- true if arbitrary slots allowed, false otherwiseboolean isExtensible()
void setIconUrl(java.lang.String iconUrl) throws CSAppFrameworkException
iconUrl
- url to the type icon.CSAppFrameworkException
- if an internal error occurs.java.lang.String getIconUrl() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.void setLargeIconUrl(java.lang.String largeIconUrl) throws CSAppFrameworkException
largeIconUrl
- url to LargeTypeIcon.CSAppFrameworkException
- if an internal error occurs.java.lang.String getLargeIconUrl() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.void setIconMediaType(java.lang.String iconMediaType)
iconMediaType
- the media type of the type icon.void setIconInputStream(java.io.InputStream iconInputStream) throws CSAppFrameworkException
iconInputStream
- the input stream representing the type icon.CSAppFrameworkException
- if an internal error occurs.void setLargeIconMediaType(java.lang.String largeIconMediaType)
largeIconMediaType
- the media type of the large type icon.void setLargeIconInputStream(java.io.InputStream largeIconInputStream) throws CSAppFrameworkException
largeIconInputStream
- the input stream representing the large type icon.CSAppFrameworkException
- if an internal error occurs.void addAttribute(AttributeDescription attribute) throws CSAppFrameworkException
attribute
- the given attribute metadata .CSAppFrameworkException
- if an internal error occurs.void removeAttribute(AttributeDescription attribute) throws CSAppFrameworkException
attribute
- the selected attribute.CSAppFrameworkException
- if an internal error occurs.void addProfile(Profile profile) throws CSAppFrameworkException
profile
- the profile to the object type.CSAppFrameworkException
- if an internal error occurs.void addMandatoryProfiles() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.TypeManager.getMandatoryProfiles()
void removeProfile(Profile profile) throws CSAppFrameworkException
profile
- the profile from the object type definition.CSAppFrameworkException
- if an internal error occurs.java.util.Collection<Profile> getProfiles() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.Profile getProfile(java.lang.String name) throws CSAppFrameworkException
name
- the name of the profile.CSAppFrameworkException
- if an internal error occurs.java.util.Collection<AttributeDescription> getAttributes() throws CSAppFrameworkException
CSAppFrameworkException
- if an internal error occurs.AttributeDescription getAttributeByName(java.lang.String name) throws CSAppFrameworkException
name
- the name of the attribute.CSAppFrameworkException
- if an internal error occurs.