Interface DetailsProcessorInterface
- All Superinterfaces:
- com.sas.services.information.publicobject.ProcessorInterface,
Remote
public interface DetailsProcessorInterface
extends ProcessorInterface
This interface is used to process/get the basic information necessary
about an object, such as its description, keywords, and created/modified
dates. Most applications use this information to display
properties about an object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringName of this interface to be used when referencing this. -
Method Summary
Modifier and TypeMethodDescriptionDateGet the date this object was created.StringGets the name of the user that created the object.Gets the identity information for the user that created the object.StringThe description of this object.StringThe display name of this object.List<String> Get the keywords associated to the object.StringGets the name of the user that modified the object.Gets the identity information for the user that modified the object.DateGet the date this object was modified.StringgetName()The name of this object.List<ResponsibilityDetails> Gets the responsibilities associated to the public object.getType()Get the type descriptor associated to the public object.com.sas.util.UsageVersionThe usage version of this object.Methods inherited from interface com.sas.services.information.publicobject.ProcessorInterface
destroy, getPublicObject
-
Field Details
-
NAME
static final String NAMEName of this interface to be used when referencing this.- See Also:
-
-
Method Details
-
getType
Get the type descriptor associated to the public object.- Returns:
- the type descriptor
- Throws:
ServiceExceptionRemoteException
-
getName
The name of this object.- Returns:
- the object's name
- Throws:
ServiceExceptionRemoteException
-
getDisplayName
The display name of this object. By default, most implementations will return the same value asgetName(). However, implementations may choose to return a different value if applicable. If a different value is not avalaible, the object's name should be returned instead.- Returns:
- the object's display name
- Throws:
ServiceExceptionRemoteException
-
getDescription
The description of this object.- Returns:
- the object's description
- Throws:
ServiceExceptionRemoteException
-
getUsageVersion
The usage version of this object. Returns a null value if a usage version was not found.- Returns:
- the object's version
- Throws:
ServiceExceptionRemoteException
-
getCreateDate
Get the date this object was created.- Returns:
- created date
- Throws:
ServiceExceptionRemoteException
-
getCreatedBy
Gets the name of the user that created the object.- Returns:
- created by name
- Throws:
ServiceExceptionRemoteException
-
getCreatedByDetails
Gets the identity information for the user that created the object.- To retrieve the identity's name, use
ResponsibilityDetails.getName(). - To retrieve the identity's display name, use
ResponsibilityDetails.getUserName().
- Returns:
- created by information
- Throws:
ServiceExceptionRemoteException
- To retrieve the identity's name, use
-
getModifyDate
Get the date this object was modified.- Returns:
- modified date
- Throws:
ServiceExceptionRemoteException
-
getModifiedBy
Gets the name of the user that modified the object.- Returns:
- modified by name
- Throws:
ServiceExceptionRemoteException
-
getModifiedByDetails
Gets the identity information for the user that modified the object.- To retrieve the identity's name, use
ResponsibilityDetails.getName(). - To retrieve the identity's display name, use
ResponsibilityDetails.getUserName().
- Returns:
- modified by information
- Throws:
ServiceExceptionRemoteException
- To retrieve the identity's name, use
-
getKeywords
Get the keywords associated to the object.- Returns:
- list of keywords
- Throws:
ServiceExceptionRemoteException
-
getResponsibilities
Gets the responsibilities associated to the public object.- Returns:
- list of responsibilities
- Throws:
ServiceExceptionRemoteException
-