com.centrasite.control
Interface Item

All Known Subinterfaces:
IFavoriteItem
All Known Implementing Classes:
AbstractAce, AbstractItem, AbstractLogItem, AbstractRepositoryAce, AbstractRoleItem, ActionCategoryItem, ActionTemplateItem, AssertionLogItem, AssociationItem, AssociationTypeConceptItem, AuditableEventItem, BPELProcessItem, CentraSiteFilterItem, CentraSiteGroupItem, CentraSitePermissionItem, CentraSiteRoleItem, CentraSiteTypeDescItem, CentraSiteUserItem, ClassificationItem, ClassificationSchemeItem, ConceptItem, ConsumerApplicationItem, ErrorLogItem, EventTypeItem, ExternalIdentifierItem, ExternalLinkItem, FavoriteFolderItem, FavoriteNodeItem, FilenameInfoItem, InstanceLevelPermissionItem, LCModelItem, LoggedEventCallback.RegistryObjectLogItem, NotificationItem, OrganizationItem, PackageItem, PolicyInstanceItem, PolicyLogItem, PolicyObjectItem, ReferenceItem, RefreshItem, RegistryAce, RegistryEntryItem, RegistryGroupItem, RegistryObjectItem, RegistryObjectProxyItem, RegistryRootItem, RegistryUserItem, ReportItem, RepositoryFileAce, RepositoryFileItem, RepositoryFileProxyItem, RepositoryFolderAce, RepositoryFolderItem, RepositoryHistoryItem, RepositoryObjectItem, RepositoryOrganizationFolderItem, RepositoryRootFolderItem, RepositorySubFolderItem, RTPolicyInstanceItem, SavedSearchItem, ServiceBindingItem, ServiceItem, SpecificationLinkItem, SubscriptionItem, SysDefCentraSiteTypeDescItem, TargetItem, TargetTypeItem, TraceItem, URLItem, UserDefinedPropertyItem, UserItem, ValidLogItem, WarningLogItem, XmlSchemaItem

public interface Item

Definition of ....


Method Summary
 boolean cannotHaveChildren()
          Check whether this node may have children
 void clearCache()
          Clear cache used for items of this type
 java.util.Collection<? extends AbstractAce> getAccessControlElements()
          Get access control elements
 java.util.List getBulkCommands()
          Get list of Bulk Action commands available for the current object
 java.util.Iterator getChildren()
           
 java.util.Iterator getChildren(boolean refresh)
           
 java.util.List getCommands()
          Get list of commands available for the current object
 Connector getConnector()
          Get Connector
<T extends AbstractAce>
T
getCurrentUserPermissionItem()
          Get currently logged-in user privilege over this item, wrapped as a InstanceLevelPermissionItem.
 com.softwareag.cis.plugin.command.Command getDefaultCommand()
           
 java.lang.String getDescription()
           
 com.softwareag.cis.plugin.command.Command getDetailsCommand()
           
 java.util.List getDetailViewTabs()
          Get list of tabs for a detail view
 java.lang.String getImageURL()
           
 Item getItem()
          Returns the Item
 java.lang.String getKey()
          Obtain a unique key for class of icons
 java.util.Locale getLanguage()
          Get Language
 java.util.Locale getLocale()
          Get Locale
 java.lang.String getName()
           
 java.lang.String getNameEx()
          Get "extended/alternate name".
 java.lang.String getPath()
           
 PrivilegeDescriptor getPrivilegeDescriptor()
           
 java.util.List<Item> getRelatedItems()
           
 ReportInterface getReport()
           
 ReportInterface getReportForDetailView()
          Get report to be used for data access in detail view of THIS Item - not for child nodes!
 boolean hasNoChildren()
           
 boolean hasRequiredAttribute()
           
 boolean isLocked()
           
 boolean isModified()
          Check whether this Item is modified vs. its corresponding persistent version
 boolean isReadOnly()
           
 boolean isSubTabModified()
           
 void save(ActionContext actionContext)
          Save Item
 void setAccessControlElements(java.util.Collection<? extends AbstractAce> accessControlElements)
          Set access control elements
 void setLocked(boolean locked)
           
 void setRelatedItems(java.util.List<Item> relatedItems)
           
 void setRequiredAttribute(boolean hasRequiredAttribute)
           
 void setTabModified(boolean isSubTabModified)
           
 void showDetailView(ActionContext actionContext)
          Show the details for this item
 void showReport(ActionContext actionContext)
          Show a report for this item.
 

Method Detail

getName

java.lang.String getName()
                         throws java.lang.Exception
Throws:
java.lang.Exception

getNameEx

java.lang.String getNameEx()
                           throws java.lang.Exception
Get "extended/alternate name". This method is only used in some rare locations e.g. currently when obtaining the label of an item in the tree. Its usage is discouraged in general.

Throws:
java.lang.Exception

getDescription

java.lang.String getDescription()
                                throws java.lang.Exception
Throws:
java.lang.Exception

getChildren

java.util.Iterator getChildren()
                               throws java.lang.Exception
Throws:
java.lang.Exception

getChildren

java.util.Iterator getChildren(boolean refresh)
                               throws java.lang.Exception
Throws:
java.lang.Exception

getPath

java.lang.String getPath()
                         throws java.lang.Exception
Throws:
java.lang.Exception

hasNoChildren

boolean hasNoChildren()
                      throws java.lang.Exception
Throws:
java.lang.Exception

getReport

ReportInterface getReport()

getImageURL

java.lang.String getImageURL()
                             throws java.lang.Exception
Throws:
java.lang.Exception

setLocked

void setLocked(boolean locked)

isLocked

boolean isLocked()

isReadOnly

boolean isReadOnly()

getKey

java.lang.String getKey()
                        throws java.lang.Exception
Obtain a unique key for class of icons

Returns:
the key or null, if none available
Throws:
java.lang.Exception

getReportForDetailView

ReportInterface getReportForDetailView()
Get report to be used for data access in detail view of THIS Item - not for child nodes!


cannotHaveChildren

boolean cannotHaveChildren()
Check whether this node may have children

Returns:
true if this node cannot have children

getCommands

java.util.List getCommands()
Get list of commands available for the current object

Returns:
the list of commands

getBulkCommands

java.util.List getBulkCommands()
Get list of Bulk Action commands available for the current object

Returns:
the list of commands

getDefaultCommand

com.softwareag.cis.plugin.command.Command getDefaultCommand()
Returns:
Returns the defaultCommand.

getDetailsCommand

com.softwareag.cis.plugin.command.Command getDetailsCommand()
Returns:
Returns the Command that opens the Details

showDetailView

void showDetailView(ActionContext actionContext)
Show the details for this item

Parameters:
actionContext -

showReport

void showReport(ActionContext actionContext)
Show a report for this item. Whereas showDetailView() displays the details of this item, showReport() should display tables of "child" objects being contained in or classified with this item.

Parameters:
actionContext -

getPrivilegeDescriptor

PrivilegeDescriptor getPrivilegeDescriptor()
Returns:
returns the privilage descritptor interface

getAccessControlElements

java.util.Collection<? extends AbstractAce> getAccessControlElements()
                                                                     throws java.lang.Exception
Get access control elements

Returns:
List of Access Control elements
Throws:
java.lang.Exception

setAccessControlElements

void setAccessControlElements(java.util.Collection<? extends AbstractAce> accessControlElements)
                              throws java.lang.Exception
Set access control elements

Parameters:
accessControlElements - List of Access Control elements
Throws:
java.lang.Exception

isModified

boolean isModified()
Check whether this Item is modified vs. its corresponding persistent version

Returns:
true if modified, false if not modified

clearCache

void clearCache()
Clear cache used for items of this type


getItem

Item getItem()
Returns the Item


getDetailViewTabs

java.util.List getDetailViewTabs()
Get list of tabs for a detail view


save

void save(ActionContext actionContext)
          throws java.lang.Exception
Save Item

Parameters:
actionContext -
Throws:
java.lang.Exception

getConnector

Connector getConnector()
Get Connector

Returns:
the Connector referenced by this Item

getLocale

java.util.Locale getLocale()
Get Locale

Returns:
the Locale used for this Item

getLanguage

java.util.Locale getLanguage()
Get Language

Returns:
the language used for this Item

getCurrentUserPermissionItem

<T extends AbstractAce> T getCurrentUserPermissionItem()
                                                   throws java.lang.Exception
Get currently logged-in user privilege over this item, wrapped as a InstanceLevelPermissionItem.

Returns:
InstanceLevelPermissionItem or null.
Throws:
java.lang.Exception

isSubTabModified

boolean isSubTabModified()

setTabModified

void setTabModified(boolean isSubTabModified)

getRelatedItems

java.util.List<Item> getRelatedItems()

setRelatedItems

void setRelatedItems(java.util.List<Item> relatedItems)

hasRequiredAttribute

boolean hasRequiredAttribute()

setRequiredAttribute

void setRequiredAttribute(boolean hasRequiredAttribute)