com.saperion.ngc.model

Class FolderId

java.lang.Object

com.saperion.ngc.model.FolderId

All Implemented Interfaces:

Serializable

public class FolderId
extends Object
implements Serializable

Identifies a folder on the backend system.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT Root folder id.

Constructor Summary

Constructors

Constructor and Description
FolderId(String objectId, String ddcName) Creates a new FolderId.
FolderId(String objectId, String revisionId, String ddcName) Creates a new FolderId.

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	convertToObjectIdList(List<FolderId> list) Converts to a list of object id's.
static List<String>	convertToRevisionIdList(List<FolderId> list) /**Converts to a list of revision id's.
boolean	equals(Object obj)
String	getDdcName()
String	getName()
String	getObjectId()
String	getPath()
String	getRevisionId()
String	getSimpleString()
com.saperion.constants.SaFolderConstants.FOLDER_TYPE	getType()
int	hashCode()
void	setName(String value)
void	setPath(String value)
void	setType(com.saperion.constants.SaFolderConstants.FOLDER_TYPE value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT

public static final String ROOT

Root folder id.

See Also:

Constant Field Values

Constructor Detail

FolderId

public FolderId(String objectId,
        String ddcName)

Creates a new FolderId.

Parameters:

objectId - object ID of the folder. This corresponds with the SysRowId.

ddcName - ddc name

FolderId

public FolderId(String objectId,
        String revisionId,
        String ddcName)

Creates a new FolderId.

Parameters:

objectId - object ID of the document. This corresponds with the SysRowId.

revisionId - revision ID of the document. This corresponds with the HDOC.

ddcName - ddc name

Method Detail

getObjectId

public String getObjectId()

Returns:

object ID of the document. This corresponds with the SysRowId. Never null.

getRevisionId

public String getRevisionId()

Returns:

revision ID of the document or null if not available. This corresponds with the HDOC.

getDdcName

public String getDdcName()

Returns:

DDC name or null if not set.

getName

public final String getName()

Returns:

the name

setName

public final void setName(String value)

Parameters:

value - the name to set

getPath

public final String getPath()

Returns:

the path

setPath

public final void setPath(String value)

Parameters:

value - the path to set

getType

public final com.saperion.constants.SaFolderConstants.FOLDER_TYPE getType()

Returns:

the type

setType

public final void setType(com.saperion.constants.SaFolderConstants.FOLDER_TYPE value)

Parameters:

value - the type to set

convertToObjectIdList

public static final List<String> convertToObjectIdList(List<FolderId> list)

Converts to a list of object id's.

Parameters:

list - Input

Returns:

List of object id's

convertToRevisionIdList

public static final List<String> convertToRevisionIdList(List<FolderId> list)

/**Converts to a list of revision id's.

Parameters:

list - Input

Returns:

List of revision id's

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSimpleString

public String getSimpleString()

Returns:

DDC + object id

toString

public String toString()

Overrides:

toString in class Object