public class TypeDescriptionImpl extends java.lang.Object implements TypeDescription
TypeDescription
.Constructor and Description |
---|
TypeDescriptionImpl(com.centrasite.jaxr.type.CentraSiteTypeDescription csTypeDesc,
Connection connection,
java.util.Locale locale)
Creates a TypeDescription using the provided Connection, Locale and
CentraSiteTypeDescription.
|
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.
|
com.centrasite.jaxr.type.CentraSiteTypeDescription |
getCsTypeDesc()
Returns the CentraSiteTypeDescription object associated with this.
|
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.
|
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 |
setCsTypeDesc(com.centrasite.jaxr.type.CentraSiteTypeDescription csTypeDesc)
Sets the CentraSiteTypeDescription object associated with this.
|
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.
|
void |
setIconInputStream(java.io.InputStream iconInputStream)
Set the input stream representing the type icon.
|
void |
setIconMediaType(java.lang.String iconMediype)
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 largeIconMediype)
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.
|
public TypeDescriptionImpl(com.centrasite.jaxr.type.CentraSiteTypeDescription csTypeDesc, Connection connection, java.util.Locale locale) throws CSAppFrameworkException
csTypeDesc
- the centraSite type description.connection
- the JAXR connection.locale
- the current locale.CSAppFrameworkException
- if an internal error occurs.public com.centrasite.jaxr.type.CentraSiteTypeDescription getCsTypeDesc()
public void setCsTypeDesc(com.centrasite.jaxr.type.CentraSiteTypeDescription csTypeDesc)
csTypeDesc
- the CentraSiteTypeDescription object.public java.lang.String getConceptKey() throws CSAppFrameworkException
getConceptKey
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public java.lang.String getDescription()
getDescription
in interface TypeDescription
public java.lang.String getDisplayName() throws CSAppFrameworkException
getDisplayName
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public java.lang.String getIconUrl() throws CSAppFrameworkException
getIconUrl
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public java.lang.String getLargeIconUrl() throws CSAppFrameworkException
getLargeIconUrl
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public java.lang.String getLocalPart()
getLocalPart
in interface TypeDescription
public java.lang.String getName()
getName
in interface TypeDescription
public java.lang.String getNamespaceUri()
getNamespaceUri
in interface TypeDescription
public boolean isExtensible()
isExtensible
in interface TypeDescription
public void setDescription(java.lang.String description)
setDescription
in interface TypeDescription
description
- description of typepublic void setDisplayName(java.lang.String name) throws CSAppFrameworkException
setDisplayName
in interface TypeDescription
name
- the type's display name.CSAppFrameworkException
- if an internal error occurs.public void setExtensible(boolean extensible)
setExtensible
in interface TypeDescription
extensible
- true if arbitrary slots allowed, false otherwisepublic void setIconInputStream(java.io.InputStream iconInputStream) throws CSAppFrameworkException
setIconInputStream
in interface TypeDescription
iconInputStream
- the input stream representing the type icon.CSAppFrameworkException
- if an internal error occurs.public void setIconMediaType(java.lang.String iconMediype)
setIconMediaType
in interface TypeDescription
iconMediype
- the media type of the type icon.public void setIconUrl(java.lang.String iconUrl) throws CSAppFrameworkException
setIconUrl
in interface TypeDescription
iconUrl
- url to the type icon.CSAppFrameworkException
- if an internal error occurs.public void setLargeIconInputStream(java.io.InputStream largeIconInputStream) throws CSAppFrameworkException
setLargeIconInputStream
in interface TypeDescription
largeIconInputStream
- the input stream representing the large type icon.CSAppFrameworkException
- if an internal error occurs.public void setLargeIconMediaType(java.lang.String largeIconMediype)
setLargeIconMediaType
in interface TypeDescription
largeIconMediype
- the media type of the large type icon.public void setLargeIconUrl(java.lang.String largeIconUrl) throws CSAppFrameworkException
setLargeIconUrl
in interface TypeDescription
largeIconUrl
- url to LargeTypeIcon.CSAppFrameworkException
- if an internal error occurs.public void setLocalPart(java.lang.String part)
setLocalPart
in interface TypeDescription
part
- local partpublic void setName(java.lang.String name) throws CSAppFrameworkException
setName
in interface TypeDescription
name
- name in the form "{uri}local-name".CSAppFrameworkException
- if an internal error occurs.public void setNamespaceUri(java.lang.String namespaceUri)
setNamespaceUri
in interface TypeDescription
namespaceUri
- namespace URI.public void addAttribute(AttributeDescription attribute) throws CSAppFrameworkException
addAttribute
in interface TypeDescription
attribute
- the given attribute metadata .CSAppFrameworkException
- if an internal error occurs.public void addProfile(Profile profile) throws CSAppFrameworkException
addProfile
in interface TypeDescription
profile
- the profile to the object type.CSAppFrameworkException
- if an internal error occurs.public java.util.Collection<Profile> getProfiles() throws CSAppFrameworkException
getProfiles
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public Profile getProfile(java.lang.String name) throws CSAppFrameworkException
getProfile
in interface TypeDescription
name
- the name of the profile.CSAppFrameworkException
- if an internal error occurs.public java.util.Collection<AttributeDescription> getAttributes() throws CSAppFrameworkException
getAttributes
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.public void removeAttribute(AttributeDescription attribute) throws CSAppFrameworkException
removeAttribute
in interface TypeDescription
attribute
- the selected attribute.CSAppFrameworkException
- if an internal error occurs.public void removeProfile(Profile profile) throws CSAppFrameworkException
removeProfile
in interface TypeDescription
profile
- the profile from the object type definition.CSAppFrameworkException
- if an internal error occurs.public void addMandatoryProfiles() throws CSAppFrameworkException
TypeDescription
addMandatoryProfiles
in interface TypeDescription
CSAppFrameworkException
- if an internal error occurs.TypeManager.getMandatoryProfiles()
public AttributeDescription getAttributeByName(java.lang.String name) throws CSAppFrameworkException
TypeDescription
getAttributeByName
in interface TypeDescription
name
- the name of the attribute.CSAppFrameworkException
- if an internal error occurs.