com.filenet.wcm.apps.server.presentation.util
Class ActionDefinition

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
      extended bycom.filenet.wcm.apps.server.presentation.util.ActionDefinition
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
InfoPageViewDefinition

public class ActionDefinition
extends com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject

See Also:
Serialized Form

Field Summary
protected  java.lang.String id
           
protected  java.lang.String img
           
static java.lang.String IN_PROCESS_WITH_NO_MAJOR_VERSION
           
protected  com.filenet.wcm.toolkit.util.WcmString localizedTitle
           
protected  java.lang.String title
          Deprecated. use localizedTitle
protected  java.lang.String url
           
static java.lang.String VERSION_STATUS_IN_PROCESS
           
static java.lang.String VERSION_STATUS_RELEASED
           
static java.lang.String VERSION_STATUS_RESERVATION
           
static java.lang.String VERSION_STATUS_SUPERSEDED
           
 
Constructor Summary
ActionDefinition()
           
 
Method Summary
 java.lang.String getBaseURLKey()
           
 java.util.Set getClasses()
           
 java.util.Set getContentTypes()
           
 java.util.Set getExcludedClasses()
           
 java.util.Set getExcludedContentTypes()
           
 java.util.Set getExcludedObjectTypes()
           
 java.lang.String getIconURL()
           
 java.lang.String getId()
           
 int getMultiSelectPopupHeight()
           
 int getMultiSelectPopupWidth()
           
 java.lang.String getMultiSelectURL()
           
 java.util.Set getObjectTypes()
           
 int getPopupHeight()
           
 int getPopupWidth()
           
 java.lang.String getReturnParameters()
           
 java.util.Set getRoles()
           
 java.lang.String[] getSubActions()
           
 java.lang.String getTitle()
          Deprecated. use getTitle(Locale)
 java.lang.String getTitle(java.util.Locale locale)
          Returns localizedTitle
 java.lang.String getTitleForSitePreferences()
          Deprecated. use getTitleForSitePreferences(Locale locale)
 java.lang.String getTitleForSitePreferences(java.util.Locale locale)
           
 java.lang.String getURL()
           
 boolean getUseToken()
           
protected  void initialize()
           
 boolean isForCompoundDocumentOnly()
           
 boolean isForCustomObjectsOnly()
           
 boolean isForMailConfigured()
           
 boolean isForRecordsManagementOnly()
           
 boolean isForShortcutsPageOnly()
           
 boolean isForWcmOnly()
           
 boolean isHiddenForGuests()
           
 boolean isHiddenForVersions()
           
 boolean isHiddenIfAlreadyDeclared()
           
 boolean isHiddenInInfoPages()
           
 boolean isHiddenInShortcutsPage()
           
 boolean isHiddenInSitePreferences()
           
 boolean isHiddenInThickClientWindow()
           
 boolean isPopup()
           
 boolean isPopupInMultiSelect()
           
 boolean isShowInPath()
           
static java.lang.String removeSpaces(java.lang.String str)
           
 boolean requestWindowId()
           
protected  void saveToXML(java.io.Writer w)
           
 void setTitle(com.filenet.wcm.toolkit.util.WcmString title)
          Sets the localizedTitle
 void setUseToken(boolean useToken)
           
 boolean verifyAction(java.io.PrintWriter w, ActionDefinition ad)
          This is an equivalency test that reports differences between this instance and the specified instance of an ActionDefinition object.
protected  void writeSettingAsArray(java.io.Writer w, java.lang.String key, java.util.Set values)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
clear, clearAttributes, clone, convertToBoolean, convertToBoolean, convertToInt, convertToLong, convertToPrefsLabel, convertToPrefsLabelArray, equals, get, getAttribute, getBoolean, getElementKey, getInt, getLabel, getLabelArray, getList, getLocalizedString, getString, getStringArray, getVersion, load, load, load, load, loadLabel, loadPreferences, loadPreferences, loadPreferences, persist, put, put, put, put, put, put, put, put, registerKey, remove, removeAttribute, removeLocalizedString, setAttribute, setElementKey, setVersion, toByteArrayXML, toXML, writeEndSettingTag, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeStartSettingTag, writeStartSettingTag, writeXML, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION_STATUS_RELEASED

public static final java.lang.String VERSION_STATUS_RELEASED
See Also:
Constant Field Values

VERSION_STATUS_IN_PROCESS

public static final java.lang.String VERSION_STATUS_IN_PROCESS
See Also:
Constant Field Values

VERSION_STATUS_RESERVATION

public static final java.lang.String VERSION_STATUS_RESERVATION
See Also:
Constant Field Values

VERSION_STATUS_SUPERSEDED

public static final java.lang.String VERSION_STATUS_SUPERSEDED
See Also:
Constant Field Values

IN_PROCESS_WITH_NO_MAJOR_VERSION

public static final java.lang.String IN_PROCESS_WITH_NO_MAJOR_VERSION
See Also:
Constant Field Values

id

protected java.lang.String id

localizedTitle

protected com.filenet.wcm.toolkit.util.WcmString localizedTitle

title

protected java.lang.String title
Deprecated. use localizedTitle


url

protected java.lang.String url

img

protected java.lang.String img
Constructor Detail

ActionDefinition

public ActionDefinition()
Method Detail

getSubActions

public java.lang.String[] getSubActions()

initialize

protected void initialize()

saveToXML

protected void saveToXML(java.io.Writer w)
                  throws java.io.IOException
Throws:
java.io.IOException

writeSettingAsArray

protected final void writeSettingAsArray(java.io.Writer w,
                                         java.lang.String key,
                                         java.util.Set values)
                                  throws java.io.IOException
Throws:
java.io.IOException

removeSpaces

public static java.lang.String removeSpaces(java.lang.String str)

getId

public java.lang.String getId()

getTitle

public java.lang.String getTitle(java.util.Locale locale)
Returns localizedTitle

Parameters:
locale -
Returns:
The action title.

setTitle

public void setTitle(com.filenet.wcm.toolkit.util.WcmString title)
Sets the localizedTitle

Parameters:
title - The localized title

getTitle

public java.lang.String getTitle()
Deprecated. use getTitle(Locale)

Returns:
the action title

getURL

public java.lang.String getURL()

getMultiSelectURL

public java.lang.String getMultiSelectURL()

getIconURL

public java.lang.String getIconURL()

isShowInPath

public boolean isShowInPath()

getRoles

public java.util.Set getRoles()

isPopup

public boolean isPopup()

requestWindowId

public boolean requestWindowId()

getReturnParameters

public java.lang.String getReturnParameters()

isPopupInMultiSelect

public boolean isPopupInMultiSelect()

getPopupHeight

public int getPopupHeight()

getPopupWidth

public int getPopupWidth()

getMultiSelectPopupWidth

public int getMultiSelectPopupWidth()

getMultiSelectPopupHeight

public int getMultiSelectPopupHeight()

isForWcmOnly

public boolean isForWcmOnly()

isForMailConfigured

public boolean isForMailConfigured()

isForCustomObjectsOnly

public boolean isForCustomObjectsOnly()

isForRecordsManagementOnly

public boolean isForRecordsManagementOnly()

isForCompoundDocumentOnly

public boolean isForCompoundDocumentOnly()

isHiddenIfAlreadyDeclared

public boolean isHiddenIfAlreadyDeclared()

getUseToken

public boolean getUseToken()

setUseToken

public void setUseToken(boolean useToken)

isHiddenInInfoPages

public boolean isHiddenInInfoPages()

isHiddenInThickClientWindow

public boolean isHiddenInThickClientWindow()

getExcludedContentTypes

public java.util.Set getExcludedContentTypes()

getContentTypes

public java.util.Set getContentTypes()

getObjectTypes

public java.util.Set getObjectTypes()

getExcludedObjectTypes

public java.util.Set getExcludedObjectTypes()

getClasses

public java.util.Set getClasses()

getExcludedClasses

public java.util.Set getExcludedClasses()

isHiddenInSitePreferences

public boolean isHiddenInSitePreferences()

isHiddenForGuests

public boolean isHiddenForGuests()

getTitleForSitePreferences

public java.lang.String getTitleForSitePreferences()
Deprecated. use getTitleForSitePreferences(Locale locale)

Returns:
The title for the site preference page

getTitleForSitePreferences

public java.lang.String getTitleForSitePreferences(java.util.Locale locale)

isHiddenInShortcutsPage

public boolean isHiddenInShortcutsPage()

isHiddenForVersions

public boolean isHiddenForVersions()

isForShortcutsPageOnly

public boolean isForShortcutsPageOnly()

getBaseURLKey

public java.lang.String getBaseURLKey()

verifyAction

public boolean verifyAction(java.io.PrintWriter w,
                            ActionDefinition ad)
                     throws java.io.IOException
This is an equivalency test that reports differences between this instance and the specified instance of an ActionDefinition object.

Parameters:
w -
ad -
Returns:
Throws:
java.io.IOException


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.