com.softwareag.centrasite.appl.framework.types
Interface TypeDescription

All Known Implementing Classes:
TypeDescriptionImpl

public interface TypeDescription

Description of a user defined object type.


Method Summary
 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.
 

Method Detail

setName

void setName(java.lang.String name)
             throws CSAppFrameworkException
Set the type name. Checks uniqueness of type name.

Parameters:
name - name in the form "{uri}local-name".
Throws:
CSAppFrameworkException

getName

java.lang.String getName()
Get the type name.

Returns:
name in the form "{uri}local-name".

setDisplayName

void setDisplayName(java.lang.String name)
                    throws CSAppFrameworkException
Set the type's display name.

Parameters:
name - name
Throws:
CSAppFrameworkException

getDisplayName

java.lang.String getDisplayName()
                                throws CSAppFrameworkException
Get the type's display name.

Returns:
type's display name - defaults to Concept name as obtained by getName().
Throws:
CSAppFrameworkException

setNamespaceUri

void setNamespaceUri(java.lang.String namespaceUri)
Set namespace in complete name.

Parameters:
namespaceUri - namespace URI

getNamespaceUri

java.lang.String getNamespaceUri()
Derive namespace from complete name.

Returns:
namespace

setLocalPart

void setLocalPart(java.lang.String part)
Set local part in complete name.

Parameters:
part - local part

getLocalPart

java.lang.String getLocalPart()
Derive local part from complete name.

Returns:
local part

getConceptKey

java.lang.String getConceptKey()
                               throws CSAppFrameworkException
Get associated concept key. It can be later mapped to registry bean using the BeanPool.

Returns:
associated concept key
Throws:
CSAppFrameworkException

setDescription

void setDescription(java.lang.String description)
Set the type description.

Parameters:
description - description of type

getDescription

java.lang.String getDescription()
Get the type description.

Returns:
description of type

setExtensible

void setExtensible(boolean extensible)
Deprecated. types are always extensible

Sets if arbitrary slots are allowed.

Parameters:
extensible - true if arbitrary slots allowed, false otherwise

isExtensible

boolean isExtensible()
Deprecated. types are always extensible, method always returns true

Checks if arbitrary slots are allowed

Returns:
true if arbitrary slots allowed, false otherwise

setIconUrl

void setIconUrl(java.lang.String iconUrl)
                throws CSAppFrameworkException
Set the link to the type icon.

Parameters:
iconUrl - url to the type icon
Throws:
CSAppFrameworkException

getIconUrl

java.lang.String getIconUrl()
                            throws CSAppFrameworkException
Get the link to the type icon.

Returns:
url to type icon
Throws:
CSAppFrameworkException

setLargeIconUrl

void setLargeIconUrl(java.lang.String largeIconUrl)
                     throws CSAppFrameworkException
Set the url to the LargeTypeIcon.

Parameters:
largeIconUrl - url to LargeTypeIcon
Throws:
CSAppFrameworkException

getLargeIconUrl

java.lang.String getLargeIconUrl()
                                 throws CSAppFrameworkException
Get the url to the LargeTypeIcon.

Returns:
url to LargeTypeIcon
Throws:
CSAppFrameworkException

setIconMediaType

void setIconMediaType(java.lang.String iconMediaType)
Set the media type of the type icon.

Parameters:
iconMediaType - the media type of the type icon.

setIconInputStream

void setIconInputStream(java.io.InputStream iconInputStream)
                        throws CSAppFrameworkException
Set the input stream representing the type icon.

Parameters:
iconInputStream - the input stream representing the type icon.
Throws:
CSAppFrameworkException

setLargeIconMediaType

void setLargeIconMediaType(java.lang.String largeIconMediaType)
Set the media type of the large type icon.

Parameters:
largeIconMediaType - the media type of the large type icon.

setLargeIconInputStream

void setLargeIconInputStream(java.io.InputStream largeIconInputStream)
                             throws CSAppFrameworkException
Set the input stream representing the large type icon.

Parameters:
largeIconInputStream - the input stream representing the large type icon.
Throws:
CSAppFrameworkException

addAttribute

void addAttribute(AttributeDescription attribute)
                  throws CSAppFrameworkException
Adds the given attribute metadata to the given object type.

Parameters:
attribute -
Throws:
CSAppFrameworkException

removeAttribute

void removeAttribute(AttributeDescription attribute)
                     throws CSAppFrameworkException
Removes the selected attribute from the object type

Parameters:
attribute -
Throws:
CSAppFrameworkException

addProfile

void addProfile(Profile profile)
                throws CSAppFrameworkException
Adds the given profile to the object type.

Parameters:
profile -
Throws:
CSAppFrameworkException
Since:
CentraSite 8.0

addMandatoryProfiles

void addMandatoryProfiles()
                          throws CSAppFrameworkException
Adds the mandatory for the CentraSite UI profiles to this type.

Throws:
CSAppFrameworkException
See Also:
TypeManager.getMandatoryProfiles()

removeProfile

void removeProfile(Profile profile)
                   throws CSAppFrameworkException
Removes the given profile from the object type definition.

Parameters:
profile -
Throws:
CSAppFrameworkException
Since:
CentraSite 8.0

getProfiles

java.util.Collection<Profile> getProfiles()
                                          throws CSAppFrameworkException
Gets the profiles list of an object type.

Returns:
type profiles
Throws:
CSAppFrameworkException
Since:
CentraSite 8.0

getProfile

Profile getProfile(java.lang.String name)
                   throws CSAppFrameworkException
Gets a profile of an object type for a given name.

Returns:
type profile
Throws:
CSAppFrameworkException
Since:
CentraSite 8.0

getAttributes

java.util.Collection<AttributeDescription> getAttributes()
                                                         throws CSAppFrameworkException
Gets attributes list assigned to the object type.

Returns:
type attributes
Throws:
CSAppFrameworkException

getAttributeByName

AttributeDescription getAttributeByName(java.lang.String name)
                                        throws CSAppFrameworkException
Gets attributes list assigned to the object type.

Returns:
type attributes
Throws:
CSAppFrameworkException