Package com.axemble.vdoc.sdk.impl

Class PortalLibraryViewController

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalLibraryViewController

All Implemented Interfaces:

IController, IViewController, Serializable

public class PortalLibraryViewController
extends AbstractElement
implements IViewController

Portal Library View Controller

Author:

vmartinon

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PortalLibraryViewController(IModule module)	Constructor
	PortalLibraryViewController(IModule module, IContext context, InputStream inputStream)	Uses an java.io.InputStream to build the constraints.
	PortalLibraryViewController(IModule module, IContext context, Class natureClass)	Constructor
	PortalLibraryViewController(IModule module, InputStream inputStream)	Uses an java.io.InputStream to build the constraints.
	PortalLibraryViewController(IModule module, Class natureClass)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addEqualsConstraint(String name, Object value)	Add equal constraint
void	addGreaterConstraint(String name, Object value)	Add greater than constraint
void	addGreaterOrEqualConstraint(String name, Object value)	Add greater than or equal constraint
void	addInConstraint(String name, Object value)	Add in constraint
void	addIsEmptyConstraint(String name, Object value)	Add is empty constraint
void	addIsNotEmptyConstraint(String name, Object value)	Add is not empty
void	addLessConstraint(String name, Object value)	Add less than constraint
void	addLessOrEqualsConstraint(String name, Object value)	Add less than or equal constraint
void	addLikeConstraint(String name, Object value)	Add like constraint
void	addNotEqualsConstraint(String name, Object value)	Add not equal constraint
void	addNotInConstraint(String name, Object value)	Add not in constraint
void	addNotLikeConstraint(String name, Object value)	Add not like constraint
Collection	evaluate()	Evaluate the request on the server scope
Collection	evaluate(ICatalog catalog)	Evaluate the request on the catalog scope
Collection	evaluate(ILibrary library)	Evaluate the request on the library scope
Collection	evaluate(IResourceDefinition resourceDefinition)	Evaluate the request on the resource definition scope
Collection	evaluate(ITask task)	Evaluate the request on the task scope
Collection	evaluate(IWorkflow workflow)	Evaluate the request on the workflow scope
Collection	evaluate(IWorkflowContainer workflowContainer)	Evaluate the request on the workflow container scope
int	evaluateSize()	Evaluate the request on the server scope
int	evaluateSize(ICatalog catalog)	Evaluate the request on the catalog scope
int	evaluateSize(ILibrary library)	Evaluate the request on the library scope
int	evaluateSize(IResourceDefinition resourceDefinition)	Evaluate the request on the resource definition scope
int	evaluateSize(ITask task)	Evaluate the request on the task scope
int	evaluateSize(IWorkflow workflow)	Evaluate the request on the workflow scope
int	evaluateSize(IWorkflowContainer workflowContainer)	Evaluate the request on the workflow container scope
void	setAllowSystemCatalogs(boolean allowSystemCatalogs)	Specifies if the system catalogs should be part of the result.
void	setCount(int count)	Sets the number of elements per page
void	setOrberBy(String orberBy, Class orderByType, boolean ascendant)
void	setOrderBy(String orderBy, Class orderByType, boolean ascendant)	Sets order by and sort type properties
void	setSecurityApplied(boolean securityApplied)	Specifies if the security should be applied.
void	setStart(int start)	Sets the start page
void	setStatus(int status)	Sets the required status

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Constructor Details

PortalLibraryViewController

protected PortalLibraryViewController(IModule module)

Constructor

Parameters:

module - the module

PortalLibraryViewController

@Deprecated
public PortalLibraryViewController(IModule module,
 Class natureClass)

Deprecated.

Constructor

PortalLibraryViewController

public PortalLibraryViewController(IModule module,
 IContext context,
 Class natureClass)

Constructor

Parameters:

module - the module

context - the current context

natureClass - the nature class (default is IFile)

PortalLibraryViewController

public PortalLibraryViewController(IModule module,
 InputStream inputStream)

Uses an java.io.InputStream to build the constraints.

Parameters:

module - The current module.

inputStream - The java.io.InputStream XML entry.

PortalLibraryViewController

public PortalLibraryViewController(IModule module,
 IContext context,
 InputStream inputStream)

Uses an java.io.InputStream to build the constraints.

Parameters:

module - The current module.

context - The current context.

inputStream - The java.io.InputStream XML entry.

Method Details

addEqualsConstraint

public void addEqualsConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add equal constraint

Specified by:

addEqualsConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addEqualsConstraint(java.lang.String, java.lang.Object)

addGreaterConstraint

public void addGreaterConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add greater than constraint

Specified by:

addGreaterConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addGreaterConstraint(java.lang.String, java.lang.Object)

addGreaterOrEqualConstraint

public void addGreaterOrEqualConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add greater than or equal constraint

Specified by:

addGreaterOrEqualConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addGreaterOrEqualConstraint(java.lang.String, java.lang.Object)

addInConstraint

public void addInConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add in constraint

Specified by:

addInConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addInConstraint(java.lang.String, java.lang.Object)

addLessConstraint

public void addLessConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add less than constraint

Specified by:

addLessConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addLessConstraint(java.lang.String, java.lang.Object)

addLessOrEqualsConstraint

public void addLessOrEqualsConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add less than or equal constraint

Specified by:

addLessOrEqualsConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addLessOrEqualsConstraint(java.lang.String, java.lang.Object)

addLikeConstraint

public void addLikeConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add like constraint

Specified by:

addLikeConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addLikeConstraint(java.lang.String, java.lang.Object)

addIsEmptyConstraint

public void addIsEmptyConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add is empty constraint

Specified by:

addIsEmptyConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addIsEmptyConstraint(java.lang.String, java.lang.Object)

addNotEqualsConstraint

public void addNotEqualsConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add not equal constraint

Specified by:

addNotEqualsConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addNotEqualsConstraint(java.lang.String, java.lang.Object)

addNotInConstraint

public void addNotInConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add not in constraint

Specified by:

addNotInConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addNotInConstraint(java.lang.String, java.lang.Object)

addNotLikeConstraint

public void addNotLikeConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add not like constraint

Specified by:

addNotLikeConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addNotLikeConstraint(java.lang.String, java.lang.Object)

addIsNotEmptyConstraint

public void addIsNotEmptyConstraint(String name,
 Object value)

Description copied from interface: IViewController

Add is not empty

Specified by:

addIsNotEmptyConstraint in interface IViewController

Parameters:

name - the name

value - the value

See Also:

• IViewController.addIsNotEmptyConstraint(java.lang.String, java.lang.Object)

evaluate

public Collection evaluate()

Description copied from interface: IViewController

Evaluate the request on the server scope

Specified by:

evaluate in interface IViewController

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate()

evaluate

public Collection evaluate(ICatalog catalog)

Description copied from interface: IViewController

Evaluate the request on the catalog scope

Specified by:

evaluate in interface IViewController

Parameters:

catalog - The ICatalog object.

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate(com.axemble.vdoc.sdk.interfaces.ICatalog)

evaluate

public Collection evaluate(IWorkflowContainer workflowContainer)

Description copied from interface: IViewController

Evaluate the request on the workflow container scope

Specified by:

evaluate in interface IViewController

Parameters:

workflowContainer - The IWorkflowContainer object.

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate(com.axemble.vdoc.sdk.interfaces.IWorkflowContainer)

evaluate

public Collection evaluate(IWorkflow workflow)

Description copied from interface: IViewController

Evaluate the request on the workflow scope

Specified by:

evaluate in interface IViewController

Parameters:

workflow - The IWorkflow object.

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate(com.axemble.vdoc.sdk.interfaces.IWorkflow)

evaluate

public Collection evaluate(ITask task)

Description copied from interface: IViewController

Evaluate the request on the task scope

Specified by:

evaluate in interface IViewController

Parameters:

task - The ITask object.

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate(com.axemble.vdoc.sdk.interfaces.ITask)

evaluate

public Collection evaluate(IResourceDefinition resourceDefinition)

Description copied from interface: IViewController

Evaluate the request on the resource definition scope

Specified by:

evaluate in interface IViewController

Parameters:

resourceDefinition - The IResourceDefinition object.

Returns:

The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

See Also:

• IViewController.evaluate(com.axemble.vdoc.sdk.interfaces.IResourceDefinition)

evaluate

public Collection evaluate(ILibrary library)

Description copied from interface: IViewController

Evaluate the request on the library scope

Specified by:

evaluate in interface IViewController

Parameters:

library - The ILibrary object.

Returns:

The returned value is a collection of IFile instances

evaluateSize

public int evaluateSize()

Description copied from interface: IViewController

Evaluate the request on the server scope

Specified by:

evaluateSize in interface IViewController

Returns:

The number of elements

See Also:

• IViewController.evaluateSize()

evaluateSize

public int evaluateSize(ICatalog catalog)

Description copied from interface: IViewController

Evaluate the request on the catalog scope

Specified by:

evaluateSize in interface IViewController

Parameters:

catalog - The ICatalog object.

Returns:

The number of elements

See Also:

• IViewController.evaluateSize(com.axemble.vdoc.sdk.interfaces.ICatalog)

evaluateSize

public int evaluateSize(IWorkflowContainer workflowContainer)

Description copied from interface: IViewController

Evaluate the request on the workflow container scope

Specified by:

evaluateSize in interface IViewController

Parameters:

workflowContainer - The IWorkflowContainer object.

Returns:

The number of elements

See Also:

• IViewController.evaluateSize(com.axemble.vdoc.sdk.interfaces.IWorkflowContainer)

evaluateSize

public int evaluateSize(IWorkflow workflow)

Description copied from interface: IViewController

Evaluate the request on the workflow scope

Specified by:

evaluateSize in interface IViewController

Parameters:

workflow - The IWorkflow object.

Returns:

The number of elements

See Also:

• IViewController.evaluateSize(com.axemble.vdoc.sdk.interfaces.IWorkflow)

evaluateSize

public int evaluateSize(ITask task)

Description copied from interface: IViewController

Evaluate the request on the task scope

Specified by:

evaluateSize in interface IViewController

Parameters:

task - The ITask object.

Returns:

The number of elements

See Also:

• IViewController.evaluateSize(com.axemble.vdoc.sdk.interfaces.ITask)

evaluateSize

public int evaluateSize(IResourceDefinition resourceDefinition)

Description copied from interface: IViewController

Evaluate the request on the resource definition scope

Specified by:

evaluateSize in interface IViewController

Parameters:

resourceDefinition - The IResourceDefinition object.

Returns:

The number of elements

See Also:

• IViewController.evaluateSize(com.axemble.vdoc.sdk.interfaces.IResourceDefinition)

evaluateSize

public int evaluateSize(ILibrary library)

Description copied from interface: IViewController

Evaluate the request on the library scope

Specified by:

evaluateSize in interface IViewController

Parameters:

library - The ILibrary object.

Returns:

The returned value is a collection of IFile instances

setAllowSystemCatalogs

public void setAllowSystemCatalogs(boolean allowSystemCatalogs)

Description copied from interface: IViewController

Specifies if the system catalogs should be part of the result.

Specified by:

setAllowSystemCatalogs in interface IViewController

Parameters:

allowSystemCatalogs - true if the system ICatalog object should be part of the result, false otherwise.

See Also:

• IViewController.setAllowSystemCatalogs(boolean)

setCount

public void setCount(int count)

Description copied from interface: IViewController

Sets the number of elements per page

Specified by:

setCount in interface IViewController

Parameters:

count - the number of elements

See Also:

• IViewController.setCount(int)

setOrberBy

public void setOrberBy(String orberBy,
 Class orderByType,
 boolean ascendant)

Specified by:

setOrberBy in interface IViewController

See Also:

• IViewController.setOrderBy(java.lang.String, java.lang.Class, boolean)

setOrderBy

public void setOrderBy(String orderBy,
 Class orderByType,
 boolean ascendant)

Description copied from interface: IViewController

Sets order by and sort type properties

Specified by:

setOrderBy in interface IViewController

Parameters:

orderBy - the order name

orderByType - the order type

ascendant - the order direction (true for ascendant, false for descendant)

See Also:

• IViewController.setOrderBy(java.lang.String, java.lang.Class, boolean)

setSecurityApplied

public void setSecurityApplied(boolean securityApplied)

Description copied from interface: IViewController

Specifies if the security should be applied.

Specified by:

setSecurityApplied in interface IViewController

Parameters:

securityApplied - true if the security should be applied, false otherwise.

See Also:

• IViewController.setSecurityApplied(boolean)

setStart

public void setStart(int start)

Description copied from interface: IViewController

Sets the start page

Specified by:

setStart in interface IViewController

Parameters:

start - the start index

See Also:

• IViewController.setStart(int)

setStatus

public void setStatus(int status)

Description copied from interface: IViewController

Sets the required status

Specified by:

setStatus in interface IViewController

Parameters:

status - The status could be one of the following values:

• IWorkflowInstance.IStatus.STARTED
• IWorkflowInstance.IStatus.ABORTED
• IWorkflowInstance.IStatus.TERMINATED
• IWorkflowInstance.IStatus.PAUSED

See Also:

• IViewController.setStatus(int)