|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TypeDescriptorInterface
This interface describes the type dictionary entry for an public object type.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_CONTAINERASSOCIATION
|
static java.lang.String |
PROPERTY_HASCONTENTBACKING
|
static java.lang.String |
PROPERTY_LABELPLURAL
|
static java.lang.String |
PROPERTY_LOCALIZERCLASS
|
static java.lang.String |
PROPERTY_LOGICALTYPECLASS
|
static java.lang.String |
PROPERTY_SEARCHALLOWED
|
static java.lang.String |
PROPERTY_TEMPLATE
|
Method Summary | |
---|---|
boolean |
allowsChildren()
Returns a boolean flag indicating if this object type allows children. |
java.util.List |
getApplicablePermissions()
Get a List of the permissions that are applicable to this type of object. |
java.lang.String |
getClassName()
Get the class name used to load an instance of this class. |
java.lang.String |
getContainerAssociation()
Get the name of the association to follow to get this object's container. |
java.lang.String |
getContainerType()
Get the container type for this type. |
java.lang.String |
getDefaultLocation()
Get the default location for objects of this type. |
java.lang.String |
getDescription()
Get the description of this type. |
java.lang.String |
getDescription(java.util.Locale locale)
Get the type description for the specified locale. |
javax.swing.Icon |
getIcon()
Return the Icon for this type. |
javax.swing.Icon |
getIcon(int size)
Return the Icon for this type. |
java.lang.String |
getIconName()
Get the String with the icon name for this type. |
java.lang.String |
getLabel()
Get the label for this type. |
java.lang.String |
getLabelPlural()
Get the plural version of the label for this type. |
java.lang.String |
getLogicalTypeClassName()
Get the name of the Java class that implements the Logical Type for this definition. |
java.lang.String |
getMetadataType()
Get the metadata type used to represent this object in the server. |
java.lang.String |
getPropertyValue(java.lang.String key)
Returns the value for an associated property. |
java.lang.String |
getTemplate()
Get the template for this object. |
java.lang.Object |
getTransportHandler()
Returns the TransportHandler for this object type. |
java.lang.String |
getType()
Get the type of this object. |
java.lang.String |
getType(java.util.Locale locale)
Get the localized type string for the specified locale. |
java.lang.String |
getTypeName()
Get the non-localized type name. |
java.lang.String |
getUsageVersion()
Get the usage version of this object type. |
boolean |
hasContentBacking()
|
void |
setApplicablePermissions(java.util.List permissionList)
Set the List of permissions applicable to this type of object. |
void |
setLogicalTypeClassName(java.lang.String logicalTypeClass)
Set the name of the Java Class that implements the logical type for this definition. |
Field Detail |
---|
static final java.lang.String PROPERTY_CONTAINERASSOCIATION
static final java.lang.String PROPERTY_LABELPLURAL
static final java.lang.String PROPERTY_TEMPLATE
static final java.lang.String PROPERTY_LOGICALTYPECLASS
static final java.lang.String PROPERTY_LOCALIZERCLASS
static final java.lang.String PROPERTY_HASCONTENTBACKING
static final java.lang.String PROPERTY_SEARCHALLOWED
Method Detail |
---|
java.lang.String getType() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getType(java.util.Locale locale) throws ServiceException, java.rmi.RemoteException
locale
- The locale to get the type string for.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getTypeName() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getDescription() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getDescription(java.util.Locale locale) throws ServiceException, java.rmi.RemoteException
locale
- The locale to retrieve the description for.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getIconName() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.javax.swing.Icon getIcon() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.javax.swing.Icon getIcon(int size) throws ServiceException, java.rmi.RemoteException
size
- The preferred size for the icon.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getUsageVersion() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getClassName() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getLabel() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getLabelPlural() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getContainerType() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getTemplate() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getContainerAssociation() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getDefaultLocation() throws ServiceException, java.rmi.RemoteException
ServiceException
java.rmi.RemoteException
java.lang.Object getTransportHandler() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.TransportHandlerInterface
boolean allowsChildren() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getLogicalTypeClassName() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void setLogicalTypeClassName(java.lang.String logicalTypeClass) throws ServiceException, java.rmi.RemoteException
logicalTypeClass
- The Logical Type class name.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getMetadataType() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List getApplicablePermissions() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void setApplicablePermissions(java.util.List permissionList) throws ServiceException, java.rmi.RemoteException
permissionList
- The List of Strings with the permission names
applicable to this type of object.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.boolean hasContentBacking() throws ServiceException, java.rmi.RemoteException
ServiceException
java.rmi.RemoteException
java.lang.String getPropertyValue(java.lang.String key) throws ServiceException, java.rmi.RemoteException
key
- the property name
ServiceException
java.rmi.RemoteException
|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |