com.saperion.ngc.resultset

Class ItemAnalyzeResult

java.lang.Object

com.saperion.ngc.resultset.ItemAnalyzeResult

public class ItemAnalyzeResult
extends Object

Item analyze result.

Constructor Summary

Constructors

Constructor and Description

ItemAnalyzeResult(ResultAccessData accessData, boolean launch, boolean unlock, boolean checkout, boolean checkOutByCurrentUser, boolean wf, boolean wfHistory, boolean wfActive, boolean filing, boolean folder, boolean link, boolean deleted, boolean retention, boolean litigationHold, boolean isStructuredLink, boolean isUnstructured, boolean hasImagesOnly, boolean hasEmptyStructure, boolean containsOnlyLinks) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ResultAccessData	getData()
boolean	hasActiveWorkflow()
boolean	hasEmptyStructure()
boolean	hasImagesOnly()
boolean	hasWorkflowHistory()
boolean	isCheckedOut()
boolean	isCheckedOutByCurrentUser()
boolean	isContainsOnlyLinks()
boolean	isDeleted()
boolean	isFilingSupported()
boolean	isFolderItem()
boolean	isInLitigationHold()
boolean	isInRetention()
boolean	isLaunchable()
boolean	isLink() Checks if is link.
boolean	isStructuredLink()
boolean	isUnlocked()
boolean	isUnstructured()
boolean	isWorkflow()

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemAnalyzeResult

public ItemAnalyzeResult(ResultAccessData accessData,
                 boolean launch,
                 boolean unlock,
                 boolean checkout,
                 boolean checkOutByCurrentUser,
                 boolean wf,
                 boolean wfHistory,
                 boolean wfActive,
                 boolean filing,
                 boolean folder,
                 boolean link,
                 boolean deleted,
                 boolean retention,
                 boolean litigationHold,
                 boolean isStructuredLink,
                 boolean isUnstructured,
                 boolean hasImagesOnly,
                 boolean hasEmptyStructure,
                 boolean containsOnlyLinks)

Constructor.

Parameters:

accessData - Access data

launch - Launchable

unlock - Unlocked

checkout - Checkout

checkOutByCurrentUser - whether the document is checked out by the current user or not

wf - Workflow

wfHistory - hasWorkflowHistory

wfActive - has active workflow

filing - filing supported

folder - is a folder

link - is link document

deleted - deleted document selected

retention - selection contains document in retention

litigationHold - selection contains document in lititgation hold

isStructuredLink - whether document is a strcutered link or not

isUnstructured - whether the document is unstructured or not

hasImagesOnly - whether all elements of the document are images or not

hasEmptyStructure - whether the document has an empty structure

containsOnlyLinks - whether the document contains nothing but links in it's structure

Method Detail

getData

public final ResultAccessData getData()

Returns:

the data

isLaunchable

public final boolean isLaunchable()

Returns:

the launchable

isUnlocked

public final boolean isUnlocked()

Returns:

the unlocked

isCheckedOut

public final boolean isCheckedOut()

Returns:

if item is checked out

isCheckedOutByCurrentUser

public final boolean isCheckedOutByCurrentUser()

Returns:

if item is checked out by the current user

isWorkflow

public final boolean isWorkflow()

Returns:

the workflow

hasWorkflowHistory

public final boolean hasWorkflowHistory()

Returns:

hasWorkflowHistory

hasActiveWorkflow

public final boolean hasActiveWorkflow()

Returns:

true, if has active workflow

isFilingSupported

public final boolean isFilingSupported()

Returns:

true if filing is supported

isFolderItem

public final boolean isFolderItem()

Returns:

is a folder item

isLink

public final boolean isLink()

Checks if is link.

Returns:

true, if is link

isDeleted

public boolean isDeleted()

Returns:

true if a deleted document was selected

isInRetention

public boolean isInRetention()

Returns:

true if selection contains a document that is in retention

isInLitigationHold

public boolean isInLitigationHold()

Returns:

true if selection contains a document that is in litigation hold

isStructuredLink

public boolean isStructuredLink()

Returns:

true if document is a structured link (only one element of type link in structure)

isUnstructured

public boolean isUnstructured()

Returns:

true if document is unstructured

hasImagesOnly

public boolean hasImagesOnly()

Returns:

true if all elements of the document are images

hasEmptyStructure

public boolean hasEmptyStructure()

Returns:

true if the document has an empty structure

isContainsOnlyLinks

public boolean isContainsOnlyLinks()

Returns:

true, if the document contains only links in it's structure