com.centrasite.control.discovery
Interface PropertyAccessor

All Known Subinterfaces:
ExtensionPropertyAccessor
All Known Implementing Classes:
AbstractPropertyAccessor, AbstractRegistryObjectExternalClassificationAccessor, ActionDescAccessors, ActionNameAccessors, ActionTypeAccessors, ActionVersionAccessors, AssetChangeOrgAccessor, AssetNameAccessor, AssetTypeDescAccessor, AssetTypeIconAccessor, AssetTypeNameAccessor, AssociationAssociationTypeAccessor, AssociationSourceObjectAccessor, AssociationSourceObjectIconAccessor, AssociationSourceObjectNameAccessor, AssociationSourceObjectTypeAccessor, AssociationTargetObjectAccessor, AssociationTargetObjectIconAccessor, AssociationTargetObjectNameAccessor, AssociationTargetObjectTypeAccessor, AssoTypeFwdLblAccessor, AssoTypeNameAccessor, AssoTypeRevLblAccessor, AuditableEventDescriptionAccessor, AuditableEventEventTypeAccessor, AuditableEventRegistryObjectAccessor, AuditableEventTimeStampAccessor, AuditableEventUserAccessor, CentraSiteAssetNameAccessor, CentraSiteAssetOrgNameAccessor, CentraSiteGroupDescAccessor, CentraSiteGroupNameAccessor, CentraSiteGroupOrgNameAccessor, CentraSiteOrgUserLoginAccessor, CentraSiteRoleDescAccessor, CentraSiteRoleNameAccessor, CentraSiteRoleOrgNameAccessor, CentraSiteUserIdAccessor, CentraSiteUserLoginAccessor, CentraSiteUserNameAccessor, CentraSiteUserNameOrgAccessor, CentraSiteUserOrgNameAccessor, CentraSiteUserStatusAccessor, ChangeOrgMessageAccessor, ChangeOwnerMessageAccessor, ChangeUserAssetMessageAccessor, ChangeUserMessageAccessor, ClassificationClassificationSchemeAccessor, ClassificationClassifiedObjectAccessor, ClassificationConceptAccessor, ClassificationConceptPathAccessor, ClassificationSchemeExternalAccessor, ClassificationSchemeValueTypeAccessor, ClassificationValueAccessor, ConceptClassificationSchemeAccessor, ConceptParentAccessor, ConceptPathAccessor, ConceptValueAccessor, CreatedByUserAccessor, ExportObjectDescriptionAccessor, ExportObjectNameAccessor, ExportObjectTypeAccessor, ExternalIdentifierIdentificationSchemeAccessor, ExternalIdentifierRegistryObjectAccessor, ExternalIdentifierValueAccessor, ExternalLinkExternalURIAccessor, ExternalLinkRawExternalURIAccessor, ExternalLinkValidateURIAccessor, FailedActionNameAccessor, FailedActionsAccessor, FailedDateAccessor, FailedObjectAccessor, FailedPolicyLogDateAccessor, FailedPolicyLogUserAccessor, FailedReasonAccessor, FailePolicyLogNameAccessor, GenerateReportAccessor, IconAccessor, IconOfAssociatedRegistryObjectAccessor, ImageAccessor, ImportObjectNameAccessor, ImportObjectTypeAccessor, LogDescriptionAccessor, LogKeyAccessor, LogMessageAccessor, LogNameAccessor, LogStatusAccessor, LogTimeStampAccessor, LogTypeAccessor, ObjectImageAccessor, OperationInterfaceAccessor, OperationNamespaceAccessor, OrganizationAccessor, OrganizationParentOrganizationAccessor, OrganizationPostalAddressAccessor, OrganizationPrimaryContactAccessor, OrganizationUserAssetsAccessor, OrganizationUserNameAccessor, PolicyActiveAccessor, PolicyDescAccessor, PolicyEventAccessor, PolicyLogDateAccessor, PolicyLogDocumentAccessor, PolicyLogEntityNameAccessor, PolicyLogEventTypeAccessor, PolicyLogNameAccessor, PolicyLogUserAccessor, PolicyLogUserVersionAccessor, PolicyLogVersionAccessor, PolicyNameAccessor, PolicyObjectAccessor, PolicyOrgAccessor, PolicyOwnerAccessor, PolicyPriorityAccessor, PolicyStateAccessor, PolicyUserVersionAccessor, PolicyVersionAccessor, PrincipalNameAccessor, ReadOnlyPropertyAccessor, ReadWritePropertyAccessor, ReferenceSourceObjectAccessor, ReferenceTargetObjectAccessor, ReferenceTypeAccessor, RegistryEntryExpirationAccessor, RegistryEntryExpirationTimeAccessor, RegistryEntryMajorVersionAccessor, RegistryEntryMinorVersionAccessor, RegistryEntryStabilityAccessor, RegistryEntryStatusAccessor, RegistryEntryUserVersionAccessor, RegistryLcmStateAccessor, RegistryObjectCreationDateAccessor, RegistryObjectDescriptionAccessor, RegistryObjectKeyAccessor, RegistryObjectLastModifiedDateAccessor, RegistryObjectNameAccessor, RegistryObjectNotificationActiveAccessor, RegistryObjectNotificationChangedAccessor, RegistryObjectNotificationLastChangeAccessor, RegistryObjectNotificationRequestDateAccessor, RegistryObjectOrganizationAccessor, RegistryObjectOwnerAccessor, RegistryObjectSlotAccessor, RegistryObjectSubmittingOrganizationAccessor, RegistryObjectTypeAccessor, RegistryObjectTypeOfAssociationToAccessor, RegistryObjectUserAccessor, RegistryUserNameAccessor, RepositoryFileIconAccessor, RepositoryFileSystemNameAccessor, RepositoryHistoryContentLengthAccessor, RepositoryHistoryModificationDateAccessor, RepositoryHistoryNameAccessor, RepositoryHistoryOwnerAccessor, RepositoryHistoryVersionAccessor, RepositoryNodeAttachedToAccessor, RepositoryNodeAutoVersionAccessor, RepositoryNodeCommentAccessor, RepositoryNodeContentLengthAccessor, RepositoryNodeContentTypeAccessor, RepositoryNodeCreationDateAccessor, RepositoryNodeDisplayNameAccessor, RepositoryNodeModificationDateAccessor, RepositoryNodeOwnerAccessor, RepositoryNodeUserDefinedDescriptionAccessor, RolePermDescAccessor, RolePermNameAccessor, RolePermOrgAccessor, RTPolicyActiveAccessor, RTPolicyDescAccessor, RTPolicyNameAccessor, RTPolicyObjectAccessor, RTPolicyOrgAccessor, RTPolicyOwnerAccessor, RTPolicyStateAccessor, RTPolicyUserVersionAccessor, RTPolicyVersionAccessor, RunNowMessageAccessor, RunNowNameAccessor, RunNowResultAccessor, ServiceBindingAccessURIAccessor, ServiceBindingServiceAccessor, ServiceBindingTargetBindingAccessor, ServiceBindingValidateURIAccessor, ServiceLocalNameAccessor, ServiceNamespaceAccessor, ServiceProvidingOrganizationAccessor, ServiceWSDLAccessor, SpecificationLinkServiceBindingAccessor, SpecificationLinkSpecificationObjectAccessor, SpecificationLinkUsageDescriptionAccessor, SpecificationLinkWSDLAccessor, SubscriptionActionAccessor, SubscriptionExpirationDateAccessor, SubscriptionLastNotificationStatusAccessor, SubscriptionNotificationIntervalAccessor, SubscriptionRequestorAccessor, SystemVersionAccessor, TaxonomyNameAccessor, TraceDurationAccessor, TraceMessageAccessor, TraceSeverityAccessor, TraceThrowableAccessor, TraceTimeAccessor, UserEmailAddressAccessor, UserGroupOrgAccessor, UserNameAccessor, UserOrganizationAccessor, UserOrGroupOrganizationAccessor, UserPersonNameAccessor, UserPostalAddressAccessor, UserTelephoneNumberAccessor, UserURLAccessor, VersioningMinorMajorVersionAccessor, VersioningUserVersionAccessor, VersionsChangeLogAccessor

public interface PropertyAccessor


Method Summary
 void editProperty(Item item, ActionContext actionContext, MultipleValueInputActionListener listener)
          Invoke editor for property
 java.lang.String getActivatingMessage(java.util.Locale locale)
          Get a localized message, which will displayed when this PropertyAccessor is activated in the Column Chooser
 java.util.List getCommands(Item item)
          Get list of commands associated with respective property.
 java.lang.String getDescription(java.util.Locale locale)
          Obtain a description which can be used by a tooltip for example
 java.lang.String getDisplayName(java.util.Locale locale)
          Obtain a localized display name for the property accessed using this PropertyAccessor
 java.lang.String getPropertyName()
          Obtain name of property being accessed via this accessor.
 Item getReferencedItem(Item item)
          Get the Item referenced by this property
 SelectItemDescriptor getSelectReferencedItemDescriptor(Item item)
          Provide context description for selecting referenced item
 java.lang.String getValue(Item item)
          Get value of property for given Item
 boolean isComplexProperty()
          Check whether property is complex May be due to referenced item
 boolean isDateProperty()
          Returns the current accessor is having date value or not
 boolean isIntProperty()
          Returns the current accessor is having number value or not
 boolean isReadOnly(Item item)
          Check whether accessor allows for read access only
 boolean isTextEditAllowed(Item item)
          Check whether property value may be edited directly (that is as a string)
 void selectReferencedItem(Item item, ActionContext actionContext)
          Invoke editor for property
 void setValue(Item item, java.lang.String value)
          Set value of property for given Item
 

Method Detail

getPropertyName

java.lang.String getPropertyName()
Obtain name of property being accessed via this accessor.

Returns:
The string being returned is an internal string NOT being constructed by means of I18N infrastructure. It may be used internally for storing user-specific settings for example selected columns in a table. This selection should not depend on the language!

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
Obtain a localized display name for the property accessed using this PropertyAccessor

Returns:
the localized display name

getDescription

java.lang.String getDescription(java.util.Locale locale)
Obtain a description which can be used by a tooltip for example

Returns:
a localized string of null, if no tooltip to be displayed

getValue

java.lang.String getValue(Item item)
                          throws java.lang.Exception
Get value of property for given Item

Throws:
java.lang.Exception

setValue

void setValue(Item item,
              java.lang.String value)
              throws java.lang.Exception
Set value of property for given Item

Throws:
java.lang.Exception

isReadOnly

boolean isReadOnly(Item item)
Check whether accessor allows for read access only

Parameters:
item - the item for which it is to be checked whether the access is read-only
Returns:
true if read-only

isComplexProperty

boolean isComplexProperty()
Check whether property is complex May be due to referenced item


getSelectReferencedItemDescriptor

SelectItemDescriptor getSelectReferencedItemDescriptor(Item item)
Provide context description for selecting referenced item


getReferencedItem

Item getReferencedItem(Item item)
Get the Item referenced by this property

Parameters:
item - the current Item
Returns:
the referenced Item; null, if none

isTextEditAllowed

boolean isTextEditAllowed(Item item)
Check whether property value may be edited directly (that is as a string)

Parameters:
item - the current Item

selectReferencedItem

void selectReferencedItem(Item item,
                          ActionContext actionContext)
Invoke editor for property

Parameters:
actionContext -

editProperty

void editProperty(Item item,
                  ActionContext actionContext,
                  MultipleValueInputActionListener listener)
Invoke editor for property

Parameters:
actionContext -

getCommands

java.util.List getCommands(Item item)
Get list of commands associated with respective property. These commands may e.g. be rendered in the "General" tab in a detail view.

Parameters:
item -
Returns:
the list of commands available for this property

getActivatingMessage

java.lang.String getActivatingMessage(java.util.Locale locale)
Get a localized message, which will displayed when this PropertyAccessor is activated in the Column Chooser

Returns:
The localized message

isDateProperty

boolean isDateProperty()
Returns the current accessor is having date value or not


isIntProperty

boolean isIntProperty()
Returns the current accessor is having number value or not