com.saperion.operations.document

Class GetDocumentInfo

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<SaDocInfo>

com.saperion.operations.document.GetDocumentInfo

All Implemented Interfaces:

Operation<SaDocInfo>, Serializable

public class GetDocumentInfo
extends AbstractOperation<SaDocInfo>

Gets information about the document. See SaDocInfo for details.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDocumentInfo(String hDoc, boolean currentRevision, boolean resolveLinks, boolean forceSize) Creates a new GetDocumentInfo operation.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getHDoc()
int	hashCode()
SaDocInfo	invoke() The method that will be called on the server side.
boolean	isCurrentRevision()
boolean	isForceSize()
boolean	isResolveLinks()
String	toString()

Methods inherited from class com.saperion.operations.AbstractOperation

getResult, setResult

Methods inherited from class com.saperion.operations.BaseOperation

beforeInvoke, getClientToken

Methods inherited from class java.lang.Object

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

Constructor Detail

GetDocumentInfo

public GetDocumentInfo(String hDoc,
               boolean currentRevision,
               boolean resolveLinks,
               boolean forceSize)

Creates a new GetDocumentInfo operation.

Parameters:

hDoc - hDoc of document to get information for

currentRevision - whether to resolve the current revision or not

resolveLinks - whether to resolve links or not

forceSize - if true, the sizes of all elements will be determined. This is not a fast operation.

Method Detail

invoke

public SaDocInfo invoke()
                 throws Exception

Description copied from interface: Operation

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

Exception - exception when invoking this operation

getHDoc

public String getHDoc()

Returns:

hDoc of document to get information for

isCurrentRevision

public boolean isCurrentRevision()

Returns:

whether to resolve current revision or not

isResolveLinks

public boolean isResolveLinks()

Returns:

whether to resolve links or not

isForceSize

public boolean isForceSize()

Returns:

whether size determination is forced or not

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractOperation<SaDocInfo>