com.centrasite.control.favorites
Class FavoriteNodeItem

java.lang.Object
  extended by com.centrasite.control.favorites.FavoriteNodeItem
All Implemented Interfaces:
IFavoriteItem, Item

public class FavoriteNodeItem
extends java.lang.Object
implements IFavoriteItem


Constructor Summary
FavoriteNodeItem(Item item, com.centrasite.favorites.IFavorite favorite)
           
 
Method Summary
 boolean cannotHaveChildren()
          Check whether this node may have children
 void clearCache()
          Clear cache used for items of this type
 boolean equals(java.lang.Object other)
           
 java.util.Collection 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
 com.centrasite.favorites.IFavorite getIFavorite()
           
 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!
 int hashCode()
           
 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.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FavoriteNodeItem

public FavoriteNodeItem(Item item,
                        com.centrasite.favorites.IFavorite favorite)
Method Detail

getIFavorite

public com.centrasite.favorites.IFavorite getIFavorite()
Specified by:
getIFavorite in interface IFavoriteItem

cannotHaveChildren

public boolean cannotHaveChildren()
Description copied from interface: Item
Check whether this node may have children

Specified by:
cannotHaveChildren in interface Item
Returns:
true if this node cannot have children

clearCache

public void clearCache()
Description copied from interface: Item
Clear cache used for items of this type

Specified by:
clearCache in interface Item

getAccessControlElements

public java.util.Collection getAccessControlElements()
                                              throws java.lang.Exception
Description copied from interface: Item
Get access control elements

Specified by:
getAccessControlElements in interface Item
Returns:
List of Access Control elements
Throws:
java.lang.Exception

getChildren

public java.util.Iterator getChildren()
                               throws java.lang.Exception
Specified by:
getChildren in interface Item
Throws:
java.lang.Exception

getChildren

public java.util.Iterator getChildren(boolean refresh)
                               throws java.lang.Exception
Specified by:
getChildren in interface Item
Throws:
java.lang.Exception

getCommands

public java.util.List getCommands()
Description copied from interface: Item
Get list of commands available for the current object

Specified by:
getCommands in interface Item
Returns:
the list of commands

getConnector

public Connector getConnector()
Description copied from interface: Item
Get Connector

Specified by:
getConnector in interface Item
Returns:
the Connector referenced by this Item

getDefaultCommand

public com.softwareag.cis.plugin.command.Command getDefaultCommand()
Specified by:
getDefaultCommand in interface Item
Returns:
Returns the defaultCommand.

getDetailsCommand

public com.softwareag.cis.plugin.command.Command getDetailsCommand()
Specified by:
getDetailsCommand in interface Item
Returns:
Returns the Command that opens the Details

getDescription

public java.lang.String getDescription()
                                throws java.lang.Exception
Specified by:
getDescription in interface Item
Throws:
java.lang.Exception

getDetailViewTabs

public java.util.List getDetailViewTabs()
Description copied from interface: Item
Get list of tabs for a detail view

Specified by:
getDetailViewTabs in interface Item

getImageURL

public java.lang.String getImageURL()
                             throws java.lang.Exception
Specified by:
getImageURL in interface Item
Throws:
java.lang.Exception

getItem

public Item getItem()
Description copied from interface: Item
Returns the Item

Specified by:
getItem in interface Item

getKey

public java.lang.String getKey()
                        throws java.lang.Exception
Description copied from interface: Item
Obtain a unique key for class of icons

Specified by:
getKey in interface Item
Returns:
the key or null, if none available
Throws:
java.lang.Exception

getLocale

public java.util.Locale getLocale()
Description copied from interface: Item
Get Locale

Specified by:
getLocale in interface Item
Returns:
the Locale used for this Item

getName

public java.lang.String getName()
                         throws java.lang.Exception
Specified by:
getName in interface Item
Throws:
java.lang.Exception

getNameEx

public java.lang.String getNameEx()
                           throws java.lang.Exception
Description copied from interface: Item
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.

Specified by:
getNameEx in interface Item
Throws:
java.lang.Exception

getPath

public java.lang.String getPath()
                         throws java.lang.Exception
Specified by:
getPath in interface Item
Throws:
java.lang.Exception

getPrivilegeDescriptor

public PrivilegeDescriptor getPrivilegeDescriptor()
Specified by:
getPrivilegeDescriptor in interface Item
Returns:
returns the privilage descritptor interface

getReport

public ReportInterface getReport()
Specified by:
getReport in interface Item

getReportForDetailView

public ReportInterface getReportForDetailView()
Description copied from interface: Item
Get report to be used for data access in detail view of THIS Item - not for child nodes!

Specified by:
getReportForDetailView in interface Item

hasNoChildren

public boolean hasNoChildren()
                      throws java.lang.Exception
Specified by:
hasNoChildren in interface Item
Throws:
java.lang.Exception

isModified

public boolean isModified()
Description copied from interface: Item
Check whether this Item is modified vs. its corresponding persistent version

Specified by:
isModified in interface Item
Returns:
true if modified, false if not modified

isReadOnly

public boolean isReadOnly()
Specified by:
isReadOnly in interface Item

save

public void save(ActionContext actionContext)
          throws java.lang.Exception
Description copied from interface: Item
Save Item

Specified by:
save in interface Item
Throws:
java.lang.Exception

setAccessControlElements

public void setAccessControlElements(java.util.Collection<? extends AbstractAce> accessControlElements)
                              throws java.lang.Exception
Description copied from interface: Item
Set access control elements

Specified by:
setAccessControlElements in interface Item
Parameters:
accessControlElements - List of Access Control elements
Throws:
java.lang.Exception

showDetailView

public void showDetailView(ActionContext actionContext)
Description copied from interface: Item
Show the details for this item

Specified by:
showDetailView in interface Item

showReport

public void showReport(ActionContext actionContext)
Description copied from interface: Item
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.

Specified by:
showReport in interface Item

setLocked

public void setLocked(boolean locked)
Specified by:
setLocked in interface Item

isLocked

public boolean isLocked()
Specified by:
isLocked in interface Item

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getCurrentUserPermissionItem

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

Specified by:
getCurrentUserPermissionItem in interface Item
Returns:
InstanceLevelPermissionItem or null.
Throws:
java.lang.Exception

getBulkCommands

public java.util.List getBulkCommands()
Description copied from interface: Item
Get list of Bulk Action commands available for the current object

Specified by:
getBulkCommands in interface Item
Returns:
the list of commands

setTabModified

public void setTabModified(boolean isSubTabModified)
Specified by:
setTabModified in interface Item

isSubTabModified

public boolean isSubTabModified()
Specified by:
isSubTabModified in interface Item

getLanguage

public java.util.Locale getLanguage()
Description copied from interface: Item
Get Language

Specified by:
getLanguage in interface Item
Returns:
the language used for this Item

hasRequiredAttribute

public boolean hasRequiredAttribute()
Specified by:
hasRequiredAttribute in interface Item

setRequiredAttribute

public void setRequiredAttribute(boolean hasRequiredAttribute)
Specified by:
setRequiredAttribute in interface Item

setRelatedItems

public void setRelatedItems(java.util.List<Item> relatedItems)
Specified by:
setRelatedItems in interface Item

getRelatedItems

public java.util.List<Item> getRelatedItems()
Specified by:
getRelatedItems in interface Item