wt.enterprise
Interface URLActionDelegate

All Known Subinterfaces:

NavBarURLActionDelegate, WildfireNavBarCommonURLActionDelegate, WildfireURLActionDelegate

All Known Implementing Classes:

ActiveWorkspaceNavBarURLActionDelegate, AddToProjectURLActionDelegate, AllConfigurationsURLActionDelegate, AllInstancesURLActionDelegate, AllVersionsURLActionDelegate, AssociateFromWsURLActionDelegate, AssociateURLActionDelegate, AutoAssociateURLActionDelegate, AutoPartURLActionDelegate, CancelCheckoutURLActionDelegate, CancelCheckoutURLActionDelegate, ChangeActivityAddEffURLActionDelegate, ChangeItemViewEffURLActionDelegate, ChangeOrderAddEffURLActionDelegate, CheckedOutToWorkspaceURLActionDelegate, CheckedOutWorkURLActionDelegate, CheckinURLActionDelegate, CheckinURLActionDelegate, CheckInURLActionDelegate, CheckOutURLActionDelegate, CopyURLActionDelegate, CreateRepresentationURLActionDelegate, CreateRepWFURLActionDelegate, CreateTemplateCADDocumentURLActionDelegate, CreateWTProductInstanceURLActionDelegate, DefaultNavBarURLActionDelegate, DefaultProjectLinkURLActionDelegate, DefaultURLActionDelegate, DelegateNavBarURLActionDelegate, DeleteCabinetsURLActionDelegate, DeleteSearchBrowseURLActionDelegate, DeleteURLActionDelegate, DeleteURLActionDelegate, DeleteURLActionDelegate, DeleteWorkspaceURLActionDelegate, DeleteWTProductInstanceURLActionDelegate, DisableURLActionDelegate, DisassociateFromWsURLActionDelegate, DisassociateURLActionDelegate, DownloadURLActionDelegate, DropDownNoOpURLActionDelegate, DropDownSeparatorURLActionDelegate, EDACompareURLActionDelegate, EditAttachmentsURLActionDelegate, EditAttributesURLActionDelegate, EditContentURLActionDelegate, EditDisplayURLActionDelegate, EditSearchURLActionDelegate, EditStructureNavigatorURLActionDelegate, EditTablesURLActionDelegate, EditVisualURLActionDelegate, EffHistoryURLActionDelegate, ElectronicSignaturesURLActionDelegate, EnableURLActionDelegate, EPMURLContainsActionDelegate, ExportLibraryTemplateNavBarURLActionDelegate, ExportProductTemplateNavBarURLActionDelegate, ExportStatusURLActionDelegate, ExportURLActionDelegate, ForumURLActionDelegate, GeneralURLActionDelegate, GetContentURLActionDelegate, ImportStatusURLActionDelegate, ImportURLActionDelegate, IterationHistoryURLActionDelegate, LifeCycleHistoryURLActionDelegate, ListPartsURLActionDelegate, ListRepsWFURLActionDelegate, MadeFromURLActionDelegate, MoveURLActionDelegate, MoveURLActionDelegate, MoveURLActionDelegateProdStruct, MultiEditAttrURLActionDelegate, MultiRenameURLActionDelegate, MultiReviseURLActionDelegate, MyWorkspaceNavBarURLActionDelegate, NavBarURLActionDelegateHelper, NavBarURLForumActionDelegate, NewCADDocFamilyInfoURLActionDelegate, NewCADDocFamilyInfoURLActionDelegate, NewCADDocPropertyURLActionDelegate, NewCADDocRefByPageURLActionDelegate, NewCADDocRefPageURLActionDelegate, NewCadDocURLActionDelegate, NewCADDocUsedByPageURLActionDelegate, NewCADDocUsesPageURLActionDelegate, NewPartURLActionDelegate, OpenInProEURLActionDelegate, OpenInPVURLActionDelegate, PasteURLActionDelegate, PlaceHolderURLActionDelegate, ProductViewWFURLActionDelegate, ProjectLinkDetailsURLActionDelegate, PublicationURLActionDelegate, ReceiveStatusURLActionDelegate, ReceiveURLActionDelegate, RemoveDocumentFromPartURLActionDelegate, RemoveESIAssociationFromPartURLActionDelegate, RemoveURLActionDelegate, RenameURLActionDelegate, RenameURLActionDelegate, ReplaceMissDepURLActionDelegate, ReportTemplateExecuteURLActionDelegate, ReviseURLActionDelegate, ReviseURLActionDelegate, SaveAsFromWsURLActionDelegate, SaveAsLibraryTemplateNavBarURLActionDelegate, SaveAsProductTemplateNavBarURLActionDelegate, SaveAsURLActionDelegate, SaveAsURLActionDelegate, SaveAsURLActionDelegate, SendStatusURLActionDelegate, SendURLActionDelegate, SetIncorporatedURLActionDelegate, SetPlannedIncorporationURLActionDelegate, SetStateURLActionDelegate, ShareStatusURLActionDelegate, ShowDistributionListURLActionDelegate, SubmitURLActionDelegate, SubscriptionURLActionDelegate, SynchronizeWorkspaceURLActionDelegate, ThumbnailURLActionDelegate, UndoCheckoutURLActionDelegate, UndoPDMCheckoutURLActionDelegate, UpdateChangeIssueURLActionDelegate, UpdateURLActionDelegate, UpdateURLActionDelegate, UpdateWTProductInstanceURLActionDelegate, UploadURLActionDelegate, UploadURLActionDelegate, VersionHistoryURLActionDelegate, ViewableURLActionDelegate, ViewLogURLActionDelegate, ViewMarkupURLActionDelegate, VisualizationCollectionURLActionDelegate, WfCheckinURLActionDelegate, WFCheckoutURLActionDelegate, WFMoveURLActionDelegate, WsConfigSpecOptionsURLActionDelegate, WsprefURLActionDelegate

public interface URLActionDelegate

Defines utility methods for creating URLs for user actions.

Supported API: true

Extendable: true

Field Summary

static String	ACTION_NAME Deprecated.
static String	CLASS_URL Deprecated.

Method Summary

String	getActionName() Deprecated.
String	getClassURL() Deprecated.
String	getURLLabel(Locale locale) Deprecated.
void	setActionName(String a_ActionName) Deprecated.
void	setClassURL(String a_ClassURL) Deprecated.
String	URL(Object object) Deprecated.

Field Detail

ACTION_NAME

public static final String ACTION_NAME

Deprecated.

Label for the attribute; The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.

Supported API: true

See Also:

Constant Field Values

CLASS_URL

public static final String CLASS_URL

Deprecated.

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getActionName

public String getActionName()

Deprecated.

Gets the value of the attribute: ACTION_NAME. The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.

Supported API: true

Returns:

String

setActionName

public void setActionName(String a_ActionName)
                   throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: ACTION_NAME. The value to use when constructing the "action" query parameter for the url that is returned when calling the URL(Object object) method.

Supported API: true

Parameters:

a_ActionName -

Throws:

WTPropertyVetoException

getClassURL

public String getClassURL()

Deprecated.

Gets the value of the attribute: CLASS_URL.

Supported API: false

Returns:

String

setClassURL

public void setClassURL(String a_ClassURL)
                 throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: CLASS_URL.

Supported API: false

Parameters:

a_ClassURL -

Throws:

WTPropertyVetoException

URL

public String URL(Object object)
           throws WTException

Deprecated.

Returns a URL which when selected will perform the action on the object. This method should not be called when the concrete URLActionDelegate class is unknown. In that case, call BasicTemplateProcessor.getURLFromDelegate() instead.

Supported API: true

Parameters:

object -

Returns:

String

Throws:

WTException

getURLLabel

public String getURLLabel(Locale locale)

Deprecated.

Returns a localized label for a URL for the actions.

Supported API: true

Parameters:

locale -

Returns:

String