com.plumtree.uiinfrastructure.approval
Class AItemDescriptor

java.lang.Object
  com.plumtree.uiinfrastructure.approval.AItemDescriptor

Direct Known Subclasses:

DocumentItemDescriptor, ObjectItemDescriptor

public abstract class AItemDescriptor
extends java.lang.Object

Author:

Ben Geislinger This abstarct class represents an item awaiting approval.

Knows concrete subclasses are DocumentItemDescriptor and ObjectItemDescriptor.

Field Summary

protected static int	iPrimaryID
protected AActivitySpace	mySpace

Constructor Summary

protected

AItemDescriptor(java.lang.String name, java.lang.String description, java.lang.String submittedBy, XPDateTime submittedDate, AActivitySpace space, ApprovalItemType type) Creates a new AItemDescriptor object.

Method Summary

void	AddInstance(AInstanceDescriptor instance) Call this method to add an AInstanceDescriptor to this AItemDescriptor
void	Approve()
void	ClearMigrationRequest()
abstract void	Execute()
boolean	GetApprove()
boolean	GetClear()
java.lang.String	GetComment()
XPDateTime	GetDateSubmitted()
java.lang.String	GetDescription() Call this method to obtain the description of this item
java.lang.String	GetEditHRef() Call this method to get the HREF that will allow users to edit the object represented by this AItemDescriptor.
Redirect	GetEditRedirect()
boolean	GetHold()
java.lang.String	GetID() Call this method to get the ID of this item.
java.lang.String	GetImgUUID()
AInstanceDescriptor	GetInstance(java.lang.String sID) Call this method to obtain a reference to the specified AInstance descriptor.
IXPEnumerator	GetInstances() Call this method to obtain an IXPEnumerator of all AInstanceDescriptors added to this item descriptor.
java.lang.String	GetName() Call this method to obtain the name of this item.
java.lang.String	GetPreviewHRef() Call this method to get the HREF that will allow users to preview the object represented by this AItemDescriptor.
boolean	GetReject()
abstract java.lang.String	GetStatus()
java.lang.String	GetSubmittedBy()
ApprovalItemType	GetType()
void	Hold()
void	Reject()
void	SetClear(boolean b)
void	SetComment(java.lang.String s)
void	SetDescription(java.lang.String s)
void	SetEditHRef(java.lang.String s) Call this method to set the HREF that will allow users to edit the object represented by this AItemDescriptor.
void	SetEditRedirect(Redirect r)
void	SetImgUUID(java.lang.String s)
void	SetName(java.lang.String s)
void	SetPreviewHRef(java.lang.String s) Call this method to set the HREF that will allow users to preview the object represented by this AItemDescriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iPrimaryID

protected static int iPrimaryID

mySpace

protected AActivitySpace mySpace

Constructor Detail

AItemDescriptor

protected AItemDescriptor(java.lang.String name,
                          java.lang.String description,
                          java.lang.String submittedBy,
                          XPDateTime submittedDate,
                          AActivitySpace space,
                          ApprovalItemType type)

Creates a new AItemDescriptor object.

Parameters:

name - String name of the object awaiting approval

description - String description of the object awaiting approval

submittedBy - String

submittedDate - XPDateTime

Method Detail

AddInstance

public void AddInstance(AInstanceDescriptor instance)

Call this method to add an AInstanceDescriptor to this AItemDescriptor

Parameters:

instance - AInstanceDescriptor

Execute

public abstract void Execute()

Approve

public void Approve()

ClearMigrationRequest

public void ClearMigrationRequest()

GetClear

public boolean GetClear()

Returns:

SetClear

public void SetClear(boolean b)

GetComment

public java.lang.String GetComment()

Returns:

GetDateSubmitted

public XPDateTime GetDateSubmitted()

Returns:

GetDescription

public java.lang.String GetDescription()

Call this method to obtain the description of this item

Returns:

String

GetEditHRef

public java.lang.String GetEditHRef()

Call this method to get the HREF that will allow users to edit the object represented by this AItemDescriptor.

Returns:

String

GetEditRedirect

public Redirect GetEditRedirect()

Returns:

GetHold

public boolean GetHold()

GetID

public java.lang.String GetID()

Call this method to get the ID of this item.

Returns:

String id

GetImgUUID

public java.lang.String GetImgUUID()

SetImgUUID

public void SetImgUUID(java.lang.String s)

GetInstance

public AInstanceDescriptor GetInstance(java.lang.String sID)

Call this method to obtain a reference to the specified AInstance descriptor.

Parameters:

sID - String ID

Returns:

AInstanceDescriptor

GetInstances

public IXPEnumerator GetInstances()

Call this method to obtain an IXPEnumerator of all AInstanceDescriptors added to this item descriptor.

Returns:

IXPEnumerator of AInstanceDescriptors

GetName

public java.lang.String GetName()

Call this method to obtain the name of this item.

Returns:

String

GetPreviewHRef

public java.lang.String GetPreviewHRef()

Call this method to get the HREF that will allow users to preview the object represented by this AItemDescriptor.

Returns:

String

GetStatus

public abstract java.lang.String GetStatus()

Returns:

GetApprove

public boolean GetApprove()

GetReject

public boolean GetReject()

GetSubmittedBy

public java.lang.String GetSubmittedBy()

Returns:

GetType

public ApprovalItemType GetType()

Returns:

Hold

public void Hold()

Reject

public void Reject()

SetComment

public void SetComment(java.lang.String s)

Parameters:

s -

SetName

public void SetName(java.lang.String s)

SetDescription

public void SetDescription(java.lang.String s)

Parameters:

s -

SetEditHRef

public void SetEditHRef(java.lang.String s)

Call this method to set the HREF that will allow users to edit the object represented by this AItemDescriptor.

Parameters:

s - String

SetEditRedirect

public void SetEditRedirect(Redirect r)

Parameters:

r -

SetPreviewHRef

public void SetPreviewHRef(java.lang.String s)

Call this method to set the HREF that will allow users to preview the object represented by this AItemDescriptor.

Parameters:

s - String