com.sap.workspaces.indexing

Class ItemInfo

java.lang.Object
  com.sap.workspaces.indexing.ItemInfo

public class ItemInfo
extends Object

Serves as a unique identifier for an a workspace item for the purposes of indexing

Since:

1.1

Field Summary

static Map

EMPTY_MODULE_RESOURCE_PARAMTERS

Constructor Summary

protected	ItemInfo()
protected	ItemInfo(IIdentifier identifier)
protected	ItemInfo(IIdentifier identifier, String pageID)
protected	ItemInfo(IIdentifier identifier, String pageID, String moduleID)
protected	ItemInfo(ItemInfo other)

Method Summary

static ItemInfo	create() Create a new instance of ItemInfo
static ItemInfo	create(IIdentifier identifier) Create a new instance of ItemInfo, based on the specified parameters
static ItemInfo	create(IIdentifier identifier, String pageID) Create a new instance of ItemInfo, based on the specified parameters
static ItemInfo	create(IIdentifier identifier, String pageID, String moduleID) Create a new instance of ItemInfo, based on the specified parameters
static ItemInfo	create(ItemInfo other) Create a new instance of ItemInfo from another ItemInfo
String	getModuleID() Returns the ID of the module instance
String	getPageID() Returns the ID of the page
IIdentifier	getWorkspaceIdentifier() Returns the identifier of the workspace.
void	setModuleID(String moduleID) Defines the ID of the module instance
void	setPageID(String pageID) Defines the page ID
void	setWorkspaceIdentifier(IIdentifier identifier) Defines the identifier of the workspace
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MODULE_RESOURCE_PARAMTERS

public static final Map EMPTY_MODULE_RESOURCE_PARAMTERS

Constructor Detail

ItemInfo

protected ItemInfo(ItemInfo other)

ItemInfo

protected ItemInfo(IIdentifier identifier,
                   String pageID,
                   String moduleID)

ItemInfo

protected ItemInfo(IIdentifier identifier,
                   String pageID)

ItemInfo

protected ItemInfo(IIdentifier identifier)

ItemInfo

protected ItemInfo()

Method Detail

create

public static ItemInfo create(ItemInfo other)

Create a new instance of ItemInfo from another ItemInfo

Parameters:

other - the source ItemInfo

Returns:

A new instance of ItemInfo

create

public static ItemInfo create(IIdentifier identifier,
                              String pageID,
                              String moduleID)

Create a new instance of ItemInfo, based on the specified parameters

Parameters:

identifier - the workspace identifier

pageID - the page ID

moduleID - the module ID

Returns:

A new instance of ItemInfo

create

public static ItemInfo create(IIdentifier identifier,
                              String pageID)

Create a new instance of ItemInfo, based on the specified parameters

Parameters:

identifier - the workspace identifier

pageID - the page ID

Returns:

A new instance of ItemInfo

create

public static ItemInfo create(IIdentifier identifier)

Create a new instance of ItemInfo, based on the specified parameters

Parameters:

identifier - the workspace identifier

Returns:

A new instance of ItemInfo

create

public static ItemInfo create()

Create a new instance of ItemInfo

Returns:

A new instance of ItemInfo

getWorkspaceIdentifier

public IIdentifier getWorkspaceIdentifier()

Returns the identifier of the workspace.

Returns:

The workspace identifier

setWorkspaceIdentifier

public void setWorkspaceIdentifier(IIdentifier identifier)

Defines the identifier of the workspace

Parameters:

the - workspace identifier

getPageID

public String getPageID()

Returns the ID of the page

Returns:

The page ID

setPageID

public void setPageID(String pageID)

Defines the page ID

Parameters:

the - page ID

getModuleID

public String getModuleID()

Returns the ID of the module instance

Returns:

The module ID

setModuleID

public void setModuleID(String moduleID)

Defines the ID of the module instance

Parameters:

the - module ID

toString

public String toString()

Overrides:

toString in class Object