A B C D E F G H I L M N O P R S T U V W X

A

AbstractExceptionFactory<T extends Exception> - Class in com.lexmark.saperion.exceptions.mappings

Base implementation of an exception factory.

AbstractExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

AbstractExpressionVisitor<ResultType,ExceptionType extends EcmException> - Class in com.lexmark.saperion.search.context

This default implementation of ExpressionVisitor implements the iteration over children.

AbstractExpressionVisitor() - Constructor for class com.lexmark.saperion.search.context.AbstractExpressionVisitor

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.expression.BinaryOperation

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.expression.BooleanAndExpression

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.expression.BooleanNotExpression

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.expression.BooleanOrExpression

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.expression.UnaryOperation

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.query.AstNode

This method accepts the given visitor and returns the result of its visit.

accept(ExpressionVisitor<ResultType, ExceptionType>) - Method in class com.lexmark.saperion.search.query.Statement

AccessDeniedException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that the user wanted to access an entity in a way he does not have the sufficient rights for.

AccessDeniedException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.AccessDeniedException

This is the constructor used for serialization.

AccessDeniedException(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.AccessDeniedException

This constructor creates a new access denied exception.

AccessRight - Enum in com.lexmark.saperion.administration

This enumeration defines the different rights an actor may have on a specific object.

AclClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating a given access control list.

AclClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of AclClient.

AclClientImpl(AclManagementService, AclReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.AclClientImpl

AclListItemType - Class in com.lexmark.saperion.administration

List item type for access control list entities.

AclListItemType() - Constructor for class com.lexmark.saperion.administration.AclListItemType

Default constructor.

AclListItemType(AclReferenceType) - Constructor for class com.lexmark.saperion.administration.AclListItemType

Creates an access control list list item instance with the given access control list reference.

AclManagementService - Interface in com.lexmark.saperion.administration

The acl management service provides the required operations to create, read, update and delete access control list entities in the user management system.

AclManagementServiceClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating access control lists.

AclManagementServiceClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of AclManagementServiceClient.

AclManagementServiceClientImpl(AclManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

AclPropertiesType - Class in com.lexmark.saperion.administration

Data transfer object for acess control list properties.

AclPropertiesType() - Constructor for class com.lexmark.saperion.administration.AclPropertiesType

aclReferenceFromIdAndName(int, String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method create a new AclReferenceType from the id and name of the referenced acl.

aclReferenceFromName(String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method create a new AclReferenceType from the name of the referenced acl.

AclReferenceType - Class in com.lexmark.saperion.administration

An AclReferenceType uniquely identifies an ACL in a saperion system.

AclReferenceType() - Constructor for class com.lexmark.saperion.administration.AclReferenceType

AclType - Class in com.lexmark.saperion.administration

The AclType is a representation of an access control list in the user management.

AclType() - Constructor for class com.lexmark.saperion.administration.AclType

Creates a new empty ACL type.

acquireOwnership() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

acquireOwnership() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method acquires the ownership of the task for the current user.

acquireOwnership(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Acquires the ownership of a task.

ActorListItemType<T extends ActorReferenceType> - Class in com.lexmark.saperion.administration

An actor list item is a flyweight representation of an actor.

ActorListItemType(T) - Constructor for class com.lexmark.saperion.administration.ActorListItemType

Creates a new list item with the given actor reference.

ActorReferenceType - Class in com.lexmark.saperion.administration

This ReferenceType identifies members of the user administration.

ActorReferenceType() - Constructor for class com.lexmark.saperion.administration.ActorReferenceType

Creates a new actor reference.

ActorType<T extends ActorReferenceType> - Class in com.lexmark.saperion.administration

An actor is an abstract class that represents all actors in the ECM system.

ActorType(T) - Constructor for class com.lexmark.saperion.administration.ActorType

Creates a new actor object with the given reference.

ActorTypeEnum - Enum in com.lexmark.saperion.administration

Enumeration of all actor types in the system.

AdapterEcmException - Exception in com.lexmark.saperion.adapter

This runtime exception wraps an ecm exception for adapters to be able to throw ecm exceptions in a getter or setter.

AdapterEcmException(EcmException) - Constructor for exception com.lexmark.saperion.adapter.AdapterEcmException

This constructor wraps the given ecm exception in a runtime exception.

addComment(String) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

addComment(String) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method adds a comment to the workflow task.

addComment(TaskReferenceType, String) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Adds a comment to a workflow task.

addDocument(DocumentReferenceType) - Method in interface com.lexmark.saperion.client.folder.FolderDocumentSearchServiceClient

This method files the document referenced into the current folder.

addDocument(DocumentReferenceType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderDocumentSearchServiceClientImpl

addDocuments(List<DocumentReferenceType>) - Method in interface com.lexmark.saperion.client.folder.FolderDocumentSearchServiceClient

This method adds the given documents to the current folder.

addDocuments(List<DocumentReferenceType>) - Method in class com.lexmark.saperion.client.implementation.folder.FolderDocumentSearchServiceClientImpl

addDocuments(FolderReferenceType, List<DocumentReferenceType>) - Method in interface com.lexmark.saperion.folder.FolderService

This method adds the given documents to the given folder.

addExpression(Expression) - Method in class com.lexmark.saperion.search.expression.CompositeExpression

Adds a new expression to this composite.

addGroupMember(GroupReferenceType, ActorReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method adds a group or user - given by its reference - to a given group.

addMember(GroupReferenceType) - Method in interface com.lexmark.saperion.client.administration.GroupMembershipClientForGroups

This method adds a group or user - given by its reference - to the given group.

addMember(UserReferenceType) - Method in interface com.lexmark.saperion.client.administration.GroupMembershipClientForUsers

This method adds a group or user - given by its reference - to the given group.

addMember(GroupReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForGroupsImpl

addMember(UserReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForUsersImpl

addVariable(String, Object) - Method in class com.lexmark.saperion.search.context.SimpleExpressionContext

Adds a variable to the expression context.

AnnotationAccessDataType - Class in com.lexmark.saperion.document

This class holds data about access to an saperion related annotation.

AnnotationAccessDataType() - Constructor for class com.lexmark.saperion.document.AnnotationAccessDataType

AnnotationType - Class in com.lexmark.saperion.document

Common super class for types representing an annotation on a saperion document content element.

AnnotationType() - Constructor for class com.lexmark.saperion.document.AnnotationType

appendChild(DocumentElementType) - Method in interface com.lexmark.saperion.client.document.DocumentElementClient

This method appends a given document element as a child to the current one.

appendChild(DocumentElementType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentElementClientImpl

appendChildElement(DocumentRevisionReferenceType, DocumentElementReferenceType, DocumentElementType) - Method in interface com.lexmark.saperion.document.DocumentService

This method appends a child element to the document element given by its id and the id of the document the element resides in.

APPLICATION_ERROR_OFFSET - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

APPLICATION_GENERAL_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

APPLICATION_MALFORMED_ENTITY_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

ApplicationError(int) - Constructor for class com.lexmark.saperion.exceptions.application.ApplicationException.ApplicationError

Creates a new error with the given error value.

ApplicationException - Exception in com.lexmark.saperion.exceptions.application

Base implementation of ECMS application exceptions.

ApplicationException() - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Default constuctor.

ApplicationException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Exception factory constructor.

ApplicationException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given exception message.

ApplicationException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error details, exception cause and exception message.

ApplicationException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given exception cause.

ApplicationException(ApplicationException.ApplicationError) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code.

ApplicationException(ApplicationException.ApplicationError, Map<String, String>, String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

ApplicationException(ApplicationException.ApplicationError, String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code, error details, exception cause and exception message.

ApplicationException(ApplicationException.ApplicationError, String) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code and exception message.

ApplicationException(ApplicationException.ApplicationError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code and exception cause.

ApplicationException(ApplicationException.ApplicationError, String, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code and exception message.

ApplicationException(ApplicationException.ApplicationError, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.ApplicationException

Creates a new exception with the given error code and exception cause.

ApplicationException.ApplicationError - Class in com.lexmark.saperion.exceptions.application

Error code implementation for application exceptions.

ApplicationExceptionFactory - Class in com.lexmark.saperion.exceptions.mappings

Security exceptions factory implementation.

ApplicationExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory

ApplicationExceptionFactory.ApplicationErrors - Enum in com.lexmark.saperion.exceptions.mappings

Application error definitions.

ArchiveClient - Interface in com.lexmark.saperion.client.archive

This client defines the operations possible for archives.

ArchiveClientImpl - Class in com.lexmark.saperion.client.implementation.archive

This is the default implementation of ArchiveClient.

ArchiveClientImpl(ArchiveService, ArchiveReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.archive.ArchiveClientImpl

ArchiveContentEnum - Enum in com.lexmark.saperion.archive

This enumeration defines the types of content that can be contained in an archive.

ArchiveFeatureEnum - Enum in com.lexmark.saperion.archive

This enumeration defines the different features of an archive.

ArchiveIsolationEnum - Enum in com.lexmark.saperion.archive

This enumeration defines the different isolation types of an archive.

ArchiveListItemType - Class in com.lexmark.saperion.archive

This ListItemType contains basic information about an archive.

ArchiveListItemType() - Constructor for class com.lexmark.saperion.archive.ArchiveListItemType

Constructs a new ArchiveListItemType with an empty reference.

ArchiveListItemType(ArchiveReferenceType) - Constructor for class com.lexmark.saperion.archive.ArchiveListItemType

Constructs a new ArchiveListItemType with the specified reference.

archiveReferenceFromDocumentReference(DocumentReferenceType) - Static method in class com.lexmark.saperion.TypeConversions

This factory creates a reference to the archive the document with the given reference is archived in.

ArchiveReferenceType - Class in com.lexmark.saperion.archive

This ReferenceType identifies an archive.

ArchiveReferenceType() - Constructor for class com.lexmark.saperion.archive.ArchiveReferenceType

ArchiveService - Interface in com.lexmark.saperion.archive

This service provides functionality concerning archive definitions.

ArchiveServiceClient - Interface in com.lexmark.saperion.client.archive

This client provides functionality concerning archives (DDCs).

ArchiveServiceClientImpl - Class in com.lexmark.saperion.client.implementation.archive

This is the default implementation of ArchiveServiceClient.

ArchiveServiceClientImpl(ArchiveService, DocumentService, FolderService, LookupEntryService) - Constructor for class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

ArchiveType - Class in com.lexmark.saperion.archive

An ArchiveType contains detailed information about an archive.

ArchiveType(ArchiveReferenceType) - Constructor for class com.lexmark.saperion.archive.ArchiveType

Creates a new ArchiveType with the specified reference.

ArchiveType() - Constructor for class com.lexmark.saperion.archive.ArchiveType

Creates a new ArchiveType with an empty reference.

ArrowAnnotationType - Class in com.lexmark.saperion.document

This AnnotationType is rendered as an arrow or a line.

ArrowAnnotationType() - Constructor for class com.lexmark.saperion.document.ArrowAnnotationType

AstNode - Class in com.lexmark.saperion.search.query

Implementation of an abstract syntax tree node.

AstNode() - Constructor for class com.lexmark.saperion.search.query.AstNode

AUTHENTICATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

AUTHENTICATION_INVALID_HEADER - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

AUTHENTICATION_INVALID_PASSWORD - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

AUTHENTICATION_INVALID_TENANT - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

AUTHENTICATION_PASSWORD_EXPIRED - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

AUTHENTICATION_UNKNOWN_SCHEME - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

B

BACKEND_CONFIGURATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

BACKEND_CONNECTION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

BACKEND_SYSTEM_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

BackendExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.system.BackendSystemException.BackendExceptionFactory

BackendSystemError(int) - Constructor for class com.lexmark.saperion.exceptions.system.BackendSystemException.BackendSystemError

Default constructor.

BackendSystemException - Exception in com.lexmark.saperion.exceptions.system

Generic system exception.

BackendSystemException() - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Convenience constructor.

BackendSystemException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Factory constructor.

BackendSystemException(String) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given exception message.

BackendSystemException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error details, exception cause and exception message.

BackendSystemException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given exception cause.

BackendSystemException(BackendSystemException.BackendSystemError) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error code.

BackendSystemException(BackendSystemException.BackendSystemError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

BackendSystemException(BackendSystemException.BackendSystemError, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error code, error details, exception cause and exception message.

BackendSystemException(BackendSystemException.BackendSystemError, String) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error code and exception message.

BackendSystemException(BackendSystemException.BackendSystemError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.BackendSystemException

Creates a new exception with the given error code and exception cause.

BackendSystemException.BackendExceptionFactory - Class in com.lexmark.saperion.exceptions.system

Backend exception factory.

BackendSystemException.BackendSystemError - Class in com.lexmark.saperion.exceptions.system

Backend error definition.

BeanAdapter<T> - Interface in com.lexmark.saperion.adapter

Type adapters provide a mechanism to convert Saperion data objects to standard java beans, such as data transfer objects.

BeanToStringUtil - Class in com.lexmark.saperion.util

Simple toString formatter utility class.

BeanUtils - Class in com.lexmark.saperion.util

Utility class to interface with common bean utilities.

BinaryFieldType - Class in com.lexmark.saperion.archive

This FieldType contains binary values.

BinaryFieldType() - Constructor for class com.lexmark.saperion.archive.BinaryFieldType

Creates a new BinaryFieldType.

BinaryOperation - Class in com.lexmark.saperion.search.expression

This expression represents a comparision between a field and a value.

BinaryOperation() - Constructor for class com.lexmark.saperion.search.expression.BinaryOperation

BinaryOperation(String, BinaryOperation.Operator, Literal<?>) - Constructor for class com.lexmark.saperion.search.expression.BinaryOperation

BinaryOperation(String, BinaryOperation.Operator, String) - Constructor for class com.lexmark.saperion.search.expression.BinaryOperation

BinaryOperation(String, BinaryOperation.Operator, Number) - Constructor for class com.lexmark.saperion.search.expression.BinaryOperation

BinaryOperation.Operator - Enum in com.lexmark.saperion.search.expression

BooleanAndExpression - Class in com.lexmark.saperion.search.expression

The and-expression consists a set of expressions that are logically combined with an AND operator.

BooleanAndExpression() - Constructor for class com.lexmark.saperion.search.expression.BooleanAndExpression

BooleanFieldType - Class in com.lexmark.saperion.archive

This FieldType contains boolean values.

BooleanFieldType() - Constructor for class com.lexmark.saperion.archive.BooleanFieldType

Creates a new BooleanFieldType.

BooleanNotExpression - Class in com.lexmark.saperion.search.expression

This Expression is a meta expression that negates another expression.

BooleanNotExpression() - Constructor for class com.lexmark.saperion.search.expression.BooleanNotExpression

BooleanNotExpression(Expression) - Constructor for class com.lexmark.saperion.search.expression.BooleanNotExpression

BooleanOrExpression - Class in com.lexmark.saperion.search.expression

The or-expression consists a set of expressions that are logically combined with an OR operator.

BooleanOrExpression() - Constructor for class com.lexmark.saperion.search.expression.BooleanOrExpression

C

changePassword(String, String, String, LicenseEnumeration, String) - Method in class com.lexmark.saperion.client.implementation.SaperionClientFactoryImpl

changePassword(String, String, String, LicenseEnumeration, String) - Method in interface com.lexmark.saperion.client.SaperionClientFactory

This method creates a new saperion client with a new session in the context of the given user credentials.

changePassword(String, String, String, LicenseEnumeration, String) - Method in interface com.lexmark.saperion.client.spi.Connector

This method connects to the saperion server, authenticates the given credentials, changes the password and creates a ServiceFactory that uses the user context of the given credentials.

checkIntegrity() - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

checkIntegrity() - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionFactory

Performs an integrity check on the factories exception mapping registries.

CLIENT_ACCESS_DENIED - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_CONCURRENT_WRITE_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_ERROR_OFFSET - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_GENERAL_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_ILLEGAL_INPUT_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_MANDATORY_CONSTRAINT_VIOLATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_OBJECT_LOCKED_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_RESOURCE_NOT_FOUND_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_SYSTEM_FIELD_WRITE_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_UNIQUE_CONSTRAINT_VIOLATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

CLIENT_WRONG_ARCHIVE_TYPE_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

ClientError(int) - Constructor for class com.lexmark.saperion.exceptions.runtime.ClientException.ClientError

Creates a new error with the given error value.

ClientException - Exception in com.lexmark.saperion.exceptions.runtime

Client base exception.

ClientException(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given exception message.

ClientException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given exception cause.

ClientException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error details, exception cause and exception message.

ClientException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Exception factory constructor.

ClientException(ClientException.ClientError) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error code.

ClientException(ClientException.ClientError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

ClientException(ClientException.ClientError, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error code, error details, exception cause and exception message.

ClientException(ClientException.ClientError, String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error code and exception message.

ClientException(ClientException.ClientError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ClientException

Creates a new exception with the given error code and exception cause.

ClientException.ClientError - Class in com.lexmark.saperion.exceptions.runtime

Error code implementation for security exceptions.

close() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

close() - Method in interface com.lexmark.saperion.client.SaperionClient

This method closes the client.

close() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method closes the factory.

com.lexmark.saperion - package com.lexmark.saperion

com.lexmark.saperion.adapter - package com.lexmark.saperion.adapter

com.lexmark.saperion.administration - package com.lexmark.saperion.administration

This package holds data models concerning user administration.

com.lexmark.saperion.archive - package com.lexmark.saperion.archive

This package holds data models concerning saperion archives.

com.lexmark.saperion.client - package com.lexmark.saperion.client

com.lexmark.saperion.client.administration - package com.lexmark.saperion.client.administration

com.lexmark.saperion.client.archive - package com.lexmark.saperion.client.archive

com.lexmark.saperion.client.document - package com.lexmark.saperion.client.document

com.lexmark.saperion.client.folder - package com.lexmark.saperion.client.folder

com.lexmark.saperion.client.implementation - package com.lexmark.saperion.client.implementation

com.lexmark.saperion.client.implementation.administration - package com.lexmark.saperion.client.implementation.administration

com.lexmark.saperion.client.implementation.archive - package com.lexmark.saperion.client.implementation.archive

com.lexmark.saperion.client.implementation.document - package com.lexmark.saperion.client.implementation.document

com.lexmark.saperion.client.implementation.folder - package com.lexmark.saperion.client.implementation.folder

com.lexmark.saperion.client.implementation.lookup - package com.lexmark.saperion.client.implementation.lookup

com.lexmark.saperion.client.implementation.workflow - package com.lexmark.saperion.client.implementation.workflow

com.lexmark.saperion.client.lookup - package com.lexmark.saperion.client.lookup

com.lexmark.saperion.client.spi - package com.lexmark.saperion.client.spi

com.lexmark.saperion.client.workflow - package com.lexmark.saperion.client.workflow

com.lexmark.saperion.document - package com.lexmark.saperion.document

This package holds data models concerning saperion documents.

com.lexmark.saperion.exceptions - package com.lexmark.saperion.exceptions

com.lexmark.saperion.exceptions.application - package com.lexmark.saperion.exceptions.application

com.lexmark.saperion.exceptions.mappings - package com.lexmark.saperion.exceptions.mappings

com.lexmark.saperion.exceptions.runtime - package com.lexmark.saperion.exceptions.runtime

com.lexmark.saperion.exceptions.system - package com.lexmark.saperion.exceptions.system

com.lexmark.saperion.folder - package com.lexmark.saperion.folder

com.lexmark.saperion.lookup - package com.lexmark.saperion.lookup

com.lexmark.saperion.search - package com.lexmark.saperion.search

com.lexmark.saperion.search.context - package com.lexmark.saperion.search.context

com.lexmark.saperion.search.expression - package com.lexmark.saperion.search.expression

com.lexmark.saperion.search.literal - package com.lexmark.saperion.search.literal

com.lexmark.saperion.search.query - package com.lexmark.saperion.search.query

com.lexmark.saperion.util - package com.lexmark.saperion.util

com.lexmark.saperion.workflow - package com.lexmark.saperion.workflow

This package contains common types, references and enumerations for workflow-related ECM- Server functionality.

compareTo(DocumentElementReferenceType) - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

compareTo(DocumentReferenceType) - Method in class com.lexmark.saperion.document.DocumentReferenceType

compareTo(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

CompositeExpression - Class in com.lexmark.saperion.search.expression

A composite expression is a special expression type that consist of zero or more expressions in a specific order.

CompositeExpression() - Constructor for class com.lexmark.saperion.search.expression.CompositeExpression

ConcurrentWriteDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details of a ConcurrentWriteException.

ConcurrentWriteDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

ConcurrentWriteException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that an operation failed because it tried to modify an outdated version of an object.

ConcurrentWriteException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ConcurrentWriteException

This is the constructor used for serialization.

ConcurrentWriteException(String, ReferenceType, ReferenceType) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ConcurrentWriteException

This constructor creates a ConcurrentWriteException that indicates that it was attempted to write on an entity referenced by given reference while the latest version of the object is referenced by the other given reference.

ConfigurationUtils - Class in com.lexmark.saperion.util

This class contains utility methods for configuration files.

connect(String, String, LicenseEnumeration, String) - Method in interface com.lexmark.saperion.client.spi.Connector

This method connects to the saperion server, authenticates the given credentials and creates a ServiceFactory that uses the user context of the given credentials.

Connector - Interface in com.lexmark.saperion.client.spi

A connector is bound to a specific saperion system.

ConnectorFactory - Interface in com.lexmark.saperion.client.spi

This is the service interface implementations need to register.

ConnectorFactoryImpl - Class in com.lexmark.saperion.client

This implementation of ConnectorFactory allows to select the actual connection-type by specifying the property ConnectorFactoryImpl.PROPERTY_SAPERION_CONNECTION_TYPE.

ConnectorFactoryImpl() - Constructor for class com.lexmark.saperion.client.ConnectorFactoryImpl

ConstantUtils - Class in com.lexmark.saperion.util

Utility class to deal with constant definitions.

ContentDocumentElementType - Class in com.lexmark.saperion.document

This subclass of DocumentElementType indicates that the element has binary data attached to it.

ContentDocumentElementType() - Constructor for class com.lexmark.saperion.document.ContentDocumentElementType

ContentMetaDataType - Class in com.lexmark.saperion.document

This bean holds data about a content element.

ContentMetaDataType() - Constructor for class com.lexmark.saperion.document.ContentMetaDataType

convert() - Method in interface com.lexmark.saperion.adapter.BeanAdapter

The convert method creates a new instance of the adapter's data transfer object and populates the result object with the values resolved by the adapter.

convert(T) - Method in interface com.lexmark.saperion.adapter.BeanAdapter

The convert method copies all properties of the source type to the adopted target type and returns a self reference.

convert(Adapter, Type) - Static method in class com.lexmark.saperion.adapter.TypeConverter

Utility method to convert a source object to a target object.

convert(Type, Adapter) - Static method in class com.lexmark.saperion.adapter.TypeConverter

Converter method that copies all properties from the source bean type to the target native adapter.

convertChecked(Adapter) - Static method in class com.lexmark.saperion.adapter.TypeConverter

This utility method converts an adapter to its target object.

copyProperties(Object, Object) - Static method in class com.lexmark.saperion.util.BeanUtils

Copies all bean properties from the source bean to the destination.

copyProperties(Bean, Bean) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method copies the properties of the given source bean to the target bean.

copyPropertiesUntyped(Object, Object) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method copies the properties of the given source object to the target object.

copyProperty(Object, String, Object) - Static method in class com.lexmark.saperion.util.BeanUtils

Copy the specified property value to the specified destination bean.

CounterFieldType - Class in com.lexmark.saperion.archive

This FieldType contains integer values that are initialized by the server on creation and never changed.

CounterFieldType() - Constructor for class com.lexmark.saperion.archive.CounterFieldType

Creates a new IntegerFieldType.

createAcl(AclPropertiesType) - Method in interface com.lexmark.saperion.administration.AclManagementService

This method creates a new access control list with the properties and returns a reference to the new access control list.

createAcl(AclPropertiesType) - Method in interface com.lexmark.saperion.client.administration.AclManagementServiceClient

This method creates a new access control list with the given properties and returns a reference to it.

createAcl(AclPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

createArchiveReference(String, ArchiveContentEnum) - Static method in class com.lexmark.saperion.TypeConversions

Creates an archive reference with the specified name.

createDocument(ArchiveReferenceType, Map<String, PropertyType>, DocumentElementType) - Method in interface com.lexmark.saperion.client.document.DocumentServiceClient

This method creates a new document with the given properties in the given archive.

createDocument(CreateDocumentInputType) - Method in interface com.lexmark.saperion.client.document.DocumentServiceClient

This method creates a new document with the given properties in the given archive.

createDocument(ArchiveReferenceType, Map<String, PropertyType>, DocumentElementType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentServiceClientImpl

createDocument(CreateDocumentInputType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentServiceClientImpl

createDocument(ArchiveReferenceType, Map<String, PropertyType>, DocumentElementType) - Method in interface com.lexmark.saperion.document.DocumentService

This method stores a new document with the given data in the backend.

createDocument(CreateDocumentInputType) - Method in interface com.lexmark.saperion.document.DocumentService

This method stores a new document with the given data in the backend.

CreateDocumentInputType - Class in com.lexmark.saperion.document

Input data binding type for the document service create document operation containing the archive-reference, structure, ACLs and index-data of the new document.

CreateDocumentInputType() - Constructor for class com.lexmark.saperion.document.CreateDocumentInputType

createError() - Method in exception com.lexmark.saperion.exceptions.EcmException

Creates a new error representation for this exception.

createError() - Method in exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new server fault representation for this exception.

createException(ErrorType, Throwable) - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

createException(ErrorType, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

createException(String) - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

createException(String, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

createException(Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

createException(ErrorType, Throwable) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionFactory

Creates a new exception for the given service fault.

createException(ErrorType, Throwable) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

createException(String) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

createException(String, Throwable) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

createException(Throwable) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

createException(ErrorType, Throwable) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionFactory

This method creates a new exception instance for the given server fault.

createException(ErrorType, Throwable) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Creates a new exception for the given server fault.

createException(String) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Creates a new exception for the given server fault.

createException(String, Throwable) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Creates a new exception for the given server fault.

createException(Throwable) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Creates a new exception for the given server fault.

createException(ErrorType, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

createException(String) - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

createException(String, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

createException(Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

createException(ErrorType, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

createException(String) - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

createException(String, Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

createException(Throwable) - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

createFolder(ArchiveReferenceType, String, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.folder.FolderServiceClient

This method creates a new folder with the given input data.

createFolder(ArchiveReferenceType, String, Map<String, PropertyType>, FolderReferenceType) - Method in interface com.lexmark.saperion.client.folder.FolderServiceClient

This method creates a new folder with the given input data.

createFolder(CreateFolderInputType) - Method in interface com.lexmark.saperion.client.folder.FolderServiceClient

This method creates a new folder with the given input data.

createFolder(ArchiveReferenceType, String, Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.folder.FolderServiceClientImpl

createFolder(ArchiveReferenceType, String, Map<String, PropertyType>, FolderReferenceType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderServiceClientImpl

createFolder(CreateFolderInputType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderServiceClientImpl

createFolder(ArchiveReferenceType, String, Map<String, PropertyType>, FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method creates a new folder in the given folder archive.

createFolder(CreateFolderInputType) - Method in interface com.lexmark.saperion.folder.FolderService

This method creates a new folder in the given folder archive.

CreateFolderInputType - Class in com.lexmark.saperion.folder

Protocol binding type for the create folder operation.

CreateFolderInputType() - Constructor for class com.lexmark.saperion.folder.CreateFolderInputType

createGroup(GroupPropertiesType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method creates a new group with the given data in the current user's tenant.

createGroup(GroupPropertiesType) - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method creates a new group with the given properties and returns a reference to it.

createGroup(String, String, String) - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method creates a new group with the given properties and returns a reference to it.

createGroup(String) - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method is a shorthand to GroupManagementServiceClient.createGroup(String, String, String).

createGroup(GroupPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

createGroup(String, String, String) - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

createGroup(String) - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

createLookupEntry(ArchiveReferenceType, Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryServiceClientImpl

createLookupEntry(CreateLookupEntryInputType) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryServiceClientImpl

createLookupEntry(ArchiveReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryServiceClient

This method creates a new Lookup entry instance.

createLookupEntry(CreateLookupEntryInputType) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryServiceClient

This method creates a new Lookup entry instance.

createLookupEntry(ArchiveReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

Creates a new lookup entry with the given index data in the given definition.

createLookupEntry(CreateLookupEntryInputType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

Creates a new lookup entry with the given index data in the given definition.

CreateLookupEntryInputType - Class in com.lexmark.saperion.lookup

Input data binding type for the lookup-entry create operation.

CreateLookupEntryInputType() - Constructor for class com.lexmark.saperion.lookup.CreateLookupEntryInputType

createRole(RolePropertiesType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

This method creates a new role with the properties and returns a reference to the new role.

createRole(RolePropertiesType) - Method in interface com.lexmark.saperion.client.administration.RoleManagementServiceClient

This method creates a new role with the given properties and returns a reference to it.

createRole(RolePropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

createTaskReference(String) - Static method in class com.lexmark.saperion.TypeConversions

Creates a new task reference from the corresponding task process information.

createTenant(String, String, String) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method creates a new tenant with the given name and description and returns a reference to the new tenant.

createTenant(String, String, String) - Method in interface com.lexmark.saperion.client.administration.TenantManagementClient

This method creates a new tenant with the given name and description and returns a reference to the new tenant.

createTenant(String, String) - Method in interface com.lexmark.saperion.client.administration.TenantManagementClient

This method creates a new tenant with the given name and returns a reference to the new tenant.

createTenant(String, String, String) - Method in class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

createTenant(String, String) - Method in class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

createUser(CreateUserPropertiesType) - Method in interface com.lexmark.saperion.administration.UserManagementService

Creates a new user entity with the given properties in the current user's tenant.

createUser(CreateUserPropertiesType) - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method creates a new user with the given properties.

createUser(String, String, String, String, String) - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method creates a new user with the given properties.

createUser(String, String) - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This is a shorthand to UserManagementServiceClient.createUser(CreateUserPropertiesType).

createUser(CreateUserPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

createUser(String, String, String, String, String) - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

createUser(String, String) - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

CreateUserPropertiesType - Class in com.lexmark.saperion.administration

Data transfer object for user properties that can be user to create a new user.

CreateUserPropertiesType() - Constructor for class com.lexmark.saperion.administration.CreateUserPropertiesType

CurrencyFieldType - Class in com.lexmark.saperion.archive

This FieldType contains currency values.

CurrencyFieldType() - Constructor for class com.lexmark.saperion.archive.CurrencyFieldType

Creates a new CurrencyFieldType.

D

DateFieldType - Class in com.lexmark.saperion.archive

This FieldType contains date values.

DateFieldType() - Constructor for class com.lexmark.saperion.archive.DateFieldType

Creates a new DateFieldType.

DateLiteral<T extends Date> - Class in com.lexmark.saperion.search.literal

The date literal implements the required functionality to represent literals that extend from Date.

DateLiteral(T) - Constructor for class com.lexmark.saperion.search.literal.DateLiteral

Constructs a date literal with the given value.

DateTimeFieldType - Class in com.lexmark.saperion.archive

This FieldType contains date-time values.

DateTimeFieldType() - Constructor for class com.lexmark.saperion.archive.DateTimeFieldType

Creates a new DateTimeFieldType.

DEFAULT_CONNECTION_TYPE - Static variable in class com.lexmark.saperion.client.ConnectorFactoryImpl

DEFAULT_OFFSET - Static variable in class com.lexmark.saperion.search.PageDefinition

DEFAULT_PAGE_SIZE - Static variable in class com.lexmark.saperion.search.PageDefinition

delete() - Method in interface com.lexmark.saperion.client.administration.AclClient

This method deletes the access control list.

delete() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method deletes the group.

delete() - Method in interface com.lexmark.saperion.client.administration.RoleClient

This method deletes the role.

delete() - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method deletes the tenant.

delete() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method deletes the user.

delete() - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method deletes the specified document.

delete() - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method deletes the specified folder.

delete() - Method in class com.lexmark.saperion.client.implementation.administration.AclClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

delete() - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

delete() - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method deletes the lookup entry instance.

delete(FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method deletes the folder given by its reference.

delete() - Static method in class com.lexmark.saperion.Properties

This factory creates a new property that marks a property in an index data map as to delete.

deleteAcl(AclReferenceType) - Method in interface com.lexmark.saperion.administration.AclManagementService

Deletes the access control list with the given reference.

deleteDocument(DocumentRevisionReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method deletes the document referenced to by the given reference.

deleteDocumentElement(DocumentRevisionReferenceType, DocumentElementReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method deletes the document element given by its reference and a reference to the latest revision of the element it resides in.

deleteExtension() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method deletes the schema-extension properties of the group.

deleteExtension() - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method deletes the schema-extension properties of the tenant.

deleteExtension() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method deletes the schema-extension properties of the user.

deleteExtension() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

deleteExtension() - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

deleteExtension() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

deleteGroup(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

Deletes the group with the given reference.

deleteLookupEntry(LookupEntryReferenceType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

Deletes the lookup entry give by its id.

deleteRole(RoleReferenceType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

Deletes the role with the given reference.

deleteSchemaExtension(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method deletes the schema-extension of the given group.

deleteSchemaExtension(TenantReferenceType) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method deletes the schema-extension of the given tenant.

deleteSchemaExtension(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method deletes the schema-extension of the given user.

deleteTenant(TenantReferenceType) - Method in interface com.lexmark.saperion.administration.TenantManagementService

Deletes the tenant with the given reference.

deleteUser(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

Deletes the referenced user.

describe(Object) - Static method in class com.lexmark.saperion.util.BeanUtils

Describes the properties to the specified destination bean.

describe(Object) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method describes the given bean.

DocumentClient - Interface in com.lexmark.saperion.client.document

This client provides functionality concerning a given document.

DocumentClientImpl - Class in com.lexmark.saperion.client.implementation.document

This is the default implementation of DocumentClient.

DocumentClientImpl(DocumentService, DocumentReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

DocumentContentMetaDataType - Class in com.lexmark.saperion.document

This bean holds data about all the content elements of a given document.

DocumentContentMetaDataType() - Constructor for class com.lexmark.saperion.document.DocumentContentMetaDataType

DocumentElementClient - Interface in com.lexmark.saperion.client.document

This client provides functionality concerning an individual element of a given document.

DocumentElementClientImpl - Class in com.lexmark.saperion.client.implementation.document

This is the default implementation of DocumentElementClient.

DocumentElementClientImpl(DocumentService, DocumentRevisionReferenceType, DocumentElementReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.document.DocumentElementClientImpl

documentElementReferenceFromHDoc(String) - Static method in class com.lexmark.saperion.TypeConversions

For a given Saperion HDOC, this method returns the corresponding document element reference.

DocumentElementReferenceType - Class in com.lexmark.saperion.document

A DocumentElementId is an id that identifies a document element of a unique document revision.

DocumentElementReferenceType() - Constructor for class com.lexmark.saperion.document.DocumentElementReferenceType

DocumentElementStoreInformationType - Class in com.lexmark.saperion.document

This bean holds the result of a successful write call to a document element (create or update).

DocumentElementStoreInformationType() - Constructor for class com.lexmark.saperion.document.DocumentElementStoreInformationType

DocumentElementType - Class in com.lexmark.saperion.document

This class represents an element in a document structure.

DocumentElementType() - Constructor for class com.lexmark.saperion.document.DocumentElementType

Default constructor.

DocumentLockedDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details of a ObjectLockedException concerning documents.

DocumentLockedDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

DocumentNodeType - Enum in com.lexmark.saperion.document

Enumerates the different types of document elements.

DocumentReferenceType - Class in com.lexmark.saperion.document

A DocumentReferenceType is an id that identifies a document independent of revision.

DocumentReferenceType() - Constructor for class com.lexmark.saperion.document.DocumentReferenceType

documentReferenceTypeFromDatabase(String, String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new DocumentReferenceType for a given DDC name and SYSROWID.

DocumentRevisionClient - Interface in com.lexmark.saperion.client.document

This client provides read and write functionality to a given revision of a given document.

DocumentRevisionClientImpl - Class in com.lexmark.saperion.client.implementation.document

This is the default implementation of DocumentRevisionClient.

DocumentRevisionClientImpl(DocumentService, DocumentRevisionReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

DocumentRevisionListItemType - Class in com.lexmark.saperion.document

This ListItemType is a flyweight representation of a document revision.

DocumentRevisionListItemType() - Constructor for class com.lexmark.saperion.document.DocumentRevisionListItemType

Default list item constructor.

documentRevisionReferenceFromHDoc(String) - Static method in class com.lexmark.saperion.TypeConversions

For a given Saperion HDOC, this method returns the corresponding document revision reference.

DocumentRevisionReferenceType - Class in com.lexmark.saperion.document

A DocumentRevisionReferenceType is an id that identifies a saperion document revision.

DocumentRevisionReferenceType() - Constructor for class com.lexmark.saperion.document.DocumentRevisionReferenceType

DocumentRevisionType - Class in com.lexmark.saperion.document

The document revision type represents a snapshot of a document at a defined point in time.

DocumentRevisionType() - Constructor for class com.lexmark.saperion.document.DocumentRevisionType

Default constructor.

DocumentService - Interface in com.lexmark.saperion.document

Holds core document functionality.

DocumentServiceClient - Interface in com.lexmark.saperion.client.document

This client provides functionality concerning documents.

DocumentServiceClientImpl - Class in com.lexmark.saperion.client.implementation.document

This is the default implementation of DocumentServiceClient.

DocumentServiceClientImpl(DocumentService) - Constructor for class com.lexmark.saperion.client.implementation.document.DocumentServiceClientImpl

DocumentStoreInformationType - Class in com.lexmark.saperion.document

This bean holds the result of a successful document write call (create or update).

DocumentStoreInformationType() - Constructor for class com.lexmark.saperion.document.DocumentStoreInformationType

duplicates(Class<?>, Class<T>) - Static method in class com.lexmark.saperion.util.ConstantUtils

Inspects a constant definition class and returns all duplicate constant definitions of the given element type.

E

EcmErrorCodes - Class in com.lexmark.saperion.exceptions

Defines the ECM Service error codes used in the system.

EcmException - Exception in com.lexmark.saperion.exceptions

Base implementation for all ECM Service checked exceptions.

EcmException(ErrorConstantType) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code.

EcmException(ErrorConstantType, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

EcmException(ErrorConstantType, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code, error details, exception cause and exception message.

EcmException(ErrorConstantType, String) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code and exception message.

EcmException(ErrorConstantType, String, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code and exception message.

EcmException(ErrorConstantType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code and exception cause.

EcmException(ErrorConstantType, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Creates a new exception with the given error code and exception cause.

EcmException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmException

Deserialization constructor.

EcmRemoteException - Exception in com.lexmark.saperion.exceptions.runtime

Indicates that the ecm server itself has problems with a connection to another system.

EcmRemoteException(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.EcmRemoteException

EcmRemoteException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.EcmRemoteException

EcmRemoteException(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.EcmRemoteException

EcmRemoteException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.EcmRemoteException

EcmRuntimeException - Exception in com.lexmark.saperion.exceptions

Base implementation for all ECM Service runtime exceptions.

EcmRuntimeException(ErrorConstantType) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code.

EcmRuntimeException(ErrorConstantType, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

EcmRuntimeException(ErrorConstantType, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code, error details, exception cause and exception message.

EcmRuntimeException(ErrorConstantType, String) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code and exception message.

EcmRuntimeException(ErrorConstantType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code and exception cause.

EcmRuntimeException(ErrorConstantType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Creates a new exception with the given error code and exception cause.

EcmRuntimeException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.EcmRuntimeException

Deserialization constructor.

EcmsExceptionFactory - Class in com.lexmark.saperion.exceptions.mappings

Global exception factory.

EcmsExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.mappings.EcmsExceptionFactory

EcmsExceptionMapping<T extends Throwable> - Class in com.lexmark.saperion.exceptions.mappings

Base implementation of an exception mapping entry.

EcmsExceptionMapping(ErrorConstantType, Class<T>) - Constructor for class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

Creates a new exception mapping entry with the given error code and the given exception class.

emptyListProperty() - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property representing the empty list.

EnumFieldType - Class in com.lexmark.saperion.archive

This FieldType contains values that are contained in a lookup table.

EnumFieldType() - Constructor for class com.lexmark.saperion.archive.EnumFieldType

Creates a new EnumFieldType.

EnumFieldType(FieldTypeEnum) - Constructor for class com.lexmark.saperion.archive.EnumFieldType

Creates a new EnumFieldType with the specified type name.

EnumListFieldType - Class in com.lexmark.saperion.archive

This FieldType contains a list of values that are contained in a lookup table.

EnumListFieldType() - Constructor for class com.lexmark.saperion.archive.EnumListFieldType

Creates a new EnumListFieldType.

equals(Object) - Method in class com.lexmark.saperion.administration.AclReferenceType

equals(Object) - Method in class com.lexmark.saperion.administration.ActorReferenceType

equals(Object) - Method in class com.lexmark.saperion.administration.RoleReferenceType

equals(Object) - Method in class com.lexmark.saperion.administration.TenantReferenceType

equals(Object) - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

equals(Object) - Method in class com.lexmark.saperion.archive.CurrencyFieldType

equals(Object) - Method in class com.lexmark.saperion.archive.EnumFieldType

equals(Object) - Method in class com.lexmark.saperion.archive.FieldDefinition

equals(Object) - Method in class com.lexmark.saperion.archive.FieldType

equals(Object) - Method in class com.lexmark.saperion.archive.FloatFieldType

equals(Object) - Method in class com.lexmark.saperion.archive.ListFieldType

equals(Object) - Method in class com.lexmark.saperion.archive.LookupFieldType

equals(Object) - Method in class com.lexmark.saperion.archive.StringFieldType

equals(Object) - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

equals(Object) - Method in class com.lexmark.saperion.document.DocumentReferenceType

equals(Object) - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

equals(Object) - Method in class com.lexmark.saperion.exceptions.ErrorCodeType

equals(Object) - Method in class com.lexmark.saperion.folder.FolderReferenceType

equals(Object) - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

equals(Object) - Method in class com.lexmark.saperion.PropertyType

equals(Object) - Method in class com.lexmark.saperion.workflow.InboxReferenceType

equals(Object) - Method in class com.lexmark.saperion.workflow.TaskCommentReferenceType

equals(Object) - Method in class com.lexmark.saperion.workflow.TaskReferenceType

equals(Object) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

equals(Object) - Method in class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

ErrorCodeType - Class in com.lexmark.saperion.exceptions

The error code type implements the means to store and access error information.

ErrorCodeType() - Constructor for class com.lexmark.saperion.exceptions.ErrorCodeType

Creates a new error code with an error value 0.

ErrorCodeType(int) - Constructor for class com.lexmark.saperion.exceptions.ErrorCodeType

Creates a new error code with the given value.

ErrorConstantType - Class in com.lexmark.saperion.exceptions

Constant implementation of an ErrorCodeType.

ErrorConstantType(int) - Constructor for class com.lexmark.saperion.exceptions.ErrorConstantType

Creates a new constant error code.

ErrorDetailsType - Class in com.lexmark.saperion.exceptions

Error details.

ErrorDetailsType() - Constructor for class com.lexmark.saperion.exceptions.ErrorDetailsType

ErrorType - Class in com.lexmark.saperion.exceptions

The server fault type serves as a data transfer object that contains all service error information.

ErrorType() - Constructor for class com.lexmark.saperion.exceptions.ErrorType

ExceptionFactory<T extends Exception> - Interface in com.lexmark.saperion.exceptions.mappings

Exception factories create ECM Service exceptions based on server faults.

ExceptionFactory.IntegrityCheckResult - Class in com.lexmark.saperion.exceptions.mappings

Result for a exception factory integrity checks.

ExceptionMapping<T extends Throwable> - Interface in com.lexmark.saperion.exceptions.mappings

An exception mapping associates an error code with a specific exception class.

exists(Expression) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

exists(Expression) - Method in interface com.lexmark.saperion.client.SearchClient

This convenience method checks whether an element matching the filter actually exists.

expirePassword(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method makes the users password expire.

expirePassword() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method makes the users password expire.

expirePassword() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

Expression - Class in com.lexmark.saperion.search.expression

Abstract base class for all expressions.

Expression() - Constructor for class com.lexmark.saperion.search.expression.Expression

ExpressionContext - Class in com.lexmark.saperion.search.context

Definition of a expression context.

ExpressionContext() - Constructor for class com.lexmark.saperion.search.context.ExpressionContext

ExpressionVisitor<ResultType,ExceptionType extends EcmException> - Interface in com.lexmark.saperion.search.context

This interface collects the callbacks called while visiting an Expression.

F

FACTORY - Static variable in exception com.lexmark.saperion.exceptions.system.BackendSystemException

FieldDefinition - Class in com.lexmark.saperion.archive

This class defines the properties of a field contained in an archive.

FieldDefinition() - Constructor for class com.lexmark.saperion.archive.FieldDefinition

FieldOrderDescriptor - Class in com.lexmark.saperion.search.query

Defines the result set order for a particular field.

FieldOrderDescriptor(String, FieldOrderDescriptor.Order) - Constructor for class com.lexmark.saperion.search.query.FieldOrderDescriptor

Constructs a new field order type.

FieldOrderDescriptor.Order - Enum in com.lexmark.saperion.search.query

Order direction.

FieldType - Class in com.lexmark.saperion.archive

This is the abstract superclass of all FieldTypes.

FieldType(FieldTypeEnum) - Constructor for class com.lexmark.saperion.archive.FieldType

Creates a new FieldType.

FieldTypeEnum - Enum in com.lexmark.saperion.archive

This enumeration defines the different field types.

FileDocumentElementType - Class in com.lexmark.saperion.document

This document element type indicates that the current element represents a given file.

FileDocumentElementType() - Constructor for class com.lexmark.saperion.document.FileDocumentElementType

finishVisit(BooleanAndExpression, List<ResultType>) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

finishVisit(BooleanOrExpression, List<ResultType>) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

finishVisit(Statement, ResultType) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

FloatFieldType - Class in com.lexmark.saperion.archive

This FieldType contains float-values.

FloatFieldType() - Constructor for class com.lexmark.saperion.archive.FloatFieldType

Creates a new FloatFieldType.

FloatFieldType(FieldTypeEnum) - Constructor for class com.lexmark.saperion.archive.FloatFieldType

Creates a new FloatFieldType with the specified type name.

FolderClient - Interface in com.lexmark.saperion.client.folder

This client provides functionality for reading and modifying a given folder.

FolderClientImpl - Class in com.lexmark.saperion.client.implementation.folder

FolderClientImpl(FolderService, FolderReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

FolderDocumentSearchServiceClient - Interface in com.lexmark.saperion.client.folder

This search client searches documents in a given folder.

FolderDocumentSearchServiceClientImpl - Class in com.lexmark.saperion.client.implementation.folder

This is the default implementation of FolderDocumentSearchServiceClient.

FolderDocumentSearchServiceClientImpl(FolderService, SearchExecutionService<DocumentRevisionListItemType>, FolderReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.folder.FolderDocumentSearchServiceClientImpl

FolderListItemType - Class in com.lexmark.saperion.folder

This class defines the properties of a folder.

FolderListItemType() - Constructor for class com.lexmark.saperion.folder.FolderListItemType

This is the default constructor.

folderReference(String, String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new FolderReferenceType given an archive name and a sys row id.

FolderReferenceType - Class in com.lexmark.saperion.folder

Provides a reference to a folder instance in the system.

FolderReferenceType() - Constructor for class com.lexmark.saperion.folder.FolderReferenceType

Default constructor.

FolderReferenceType(String, String) - Constructor for class com.lexmark.saperion.folder.FolderReferenceType

Constructs a reference with the given values.

FolderService - Interface in com.lexmark.saperion.folder

This service provides functionality concerning folders.

FolderServiceClient - Interface in com.lexmark.saperion.client.folder

This client provides functionality concerning folders.

FolderServiceClientImpl - Class in com.lexmark.saperion.client.implementation.folder

This is the default implementation of FolderServiceClient.

FolderServiceClientImpl(FolderService) - Constructor for class com.lexmark.saperion.client.implementation.folder.FolderServiceClientImpl

formatBeanToString(Object, Class<?>, String) - Static method in class com.lexmark.saperion.util.BeanToStringUtil

Formats the properties of a bean in a toSting representation.

forward(int, List<ActorReferenceType>, String, boolean) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

forward(int, List<ActorReferenceType>, String) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

forward(List<ActorReferenceType>) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

forward(int) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

forward() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

forward(int, List<ActorReferenceType>, String, boolean) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method finishes the task execution and forwards the workflow to the next step.

forward(int, List<ActorReferenceType>, String) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method finishes the task execution and forwards the workflow to the next step.

forward(List<ActorReferenceType>) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method finishes the task execution and forwards the workflow to the next step.

forward(int) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method finishes the task execution and forwards the workflow to the next step.

forward() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method forwards a task.

forward(TaskReferenceType, int, List<ActorReferenceType>, String, boolean) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Finishes the task execution and forwards the workflow to the next step.

from(int) - Static method in enum com.lexmark.saperion.LicenseEnumeration

This method gets the correct id type for the given id.

G

GenericWorkflowErrorDetails - Class in com.lexmark.saperion.exceptions.application

This error details describe generic workflow errors.

GenericWorkflowErrorDetails() - Constructor for class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

getAccessData() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the access data.

getAclManagementService() - Method in interface com.lexmark.saperion.client.administration.UserAdministrationClient

This method returns a client offering role management functionality.

getAclManagementService() - Method in class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

getAclName() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Returns the acl name.

getACLs(AclReferenceType) - Method in interface com.lexmark.saperion.administration.AclManagementService

This method returns the ACLs currently set on the references ACL.

getAcls() - Method in class com.lexmark.saperion.administration.AclPropertiesType

getACLs(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns the ACLs currently set on the referenced group.

getAcls() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the ACLs to set on the group.

getACLs(RoleReferenceType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

This method returns the ACLs currently set on the referenced role.

getAcls() - Method in class com.lexmark.saperion.administration.RolePropertiesType

getACLs(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method returns the ACLs set on the referenced user.

getAcls() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the ACLs to set on the user.

getACLs() - Method in interface com.lexmark.saperion.client.administration.AclClient

This method returns the ACLs currently set on the ACL.

getACLs() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method returns the ACLs currently set on the group.

getACLs() - Method in interface com.lexmark.saperion.client.administration.RoleClient

This method returns the ACLs currently set on the role.

getACLs() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method returns the ACLs currently set on the user.

getACLs() - Method in interface com.lexmark.saperion.client.document.DocumentClient

This method loads the ACLs set on the current revision of the specified document.

getACLs() - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method returns the ACLs currently set on the folder.

getACLs() - Method in class com.lexmark.saperion.client.implementation.administration.AclClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

getACLs() - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

getACLs() - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method loads the ACLs that are currently set on this lookup entry.

getAcls() - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Returns the ACLs of the new document.

getACLs(DocumentReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method returns the ACLs set on the current revision of the specified document.

getAcls() - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Returns the ACLs to set when updating.

getAcls() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

Returns the ACLs to set on the new folder.

getACLs(FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method returns the ACLs of the referenced folder.

getAcls() - Method in class com.lexmark.saperion.folder.UpdateFolderInputType

Returns the ACLs to set on the folder.

getACLs(LookupEntryReferenceType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

This method returns the ACLs currently set on the specified lookup entry.

getAcls() - Method in class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

Returns the ACLs.

getActor() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task actor.

getActualArchiveKind() - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

getAlgorithmName() - Method in class com.lexmark.saperion.document.HashDescriptor

getAnnotations() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

Returns the annotations.

getArchive() - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

getArchive() - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

getArchive() - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

getArchive() - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

getArchiveByName(String) - Method in interface com.lexmark.saperion.archive.ArchiveService

This method returns the unique archive with the given name.

getArchiveReference() - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Returns the archive reference for the document create operation.

getArchiveReference() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the archive reference.

getArchiveReference() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

The archive reference identifies the archive in which the folder will be created.

getArchiveReference() - Method in class com.lexmark.saperion.lookup.CreateLookupEntryInputType

getArchiveService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getArchiveService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client to search for specific archives.

getArrayProperty(Object, String) - Static method in class com.lexmark.saperion.util.BeanUtils

Returns an array property as string array.

getArrowColor() - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Returns the arrow color.

getArrowWidth() - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Returns the arrow width.

getCapabilities() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task capabilities.

getCause() - Method in exception com.lexmark.saperion.adapter.AdapterEcmException

getChildren() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

getChildren() - Method in class com.lexmark.saperion.document.DocumentElementType

Returns the document element children.

getChildren() - Method in class com.lexmark.saperion.document.LinkDocumentElementType

getChildren() - Method in class com.lexmark.saperion.document.StructureCompositeDocumentElementType

getChildren() - Method in class com.lexmark.saperion.search.expression.CompositeExpression

Returns the child expressions contained in the composite expression.

getChildren() - Method in class com.lexmark.saperion.workflow.TaskCommentType

Returns the sub-comments of an existing comment.

getCode() - Method in class com.lexmark.saperion.exceptions.ErrorCodeType

Returns the error code value.

getColor() - Method in class com.lexmark.saperion.document.SecurityAnnotationType

Returns the color.

getColor() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the color.

getComment() - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Returns the comment for the new revision.

getComment() - Method in class com.lexmark.saperion.workflow.TaskCommentType

Returns the current comment's value.

getComments() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

getComments() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method returns the task's comments.

getComments() - Method in class com.lexmark.saperion.workflow.TaskPropertyType

Returns the comments to a workflow process.

getComments(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Returns the task's comments.

getCompressedSize() - Method in class com.lexmark.saperion.document.ContentMetaDataType

getCompressedSize() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

getContent() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

Returns the content.

getContentMetaData() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

getContentMetaData() - Method in class com.lexmark.saperion.document.DocumentRevisionType

getContentSize() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

getContentType() - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

The type of content contained in the referenced archive.

getContext() - Method in class com.lexmark.saperion.search.context.SimpleExpressionContext

Returns the context map.

getCreateDate() - Method in class com.lexmark.saperion.workflow.TaskCommentType

This method returns the date of creation.

getCreateDate() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Returns the creation date of the process.

getCreationDate() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Returns the creation date.

getCreationDate() - Method in class com.lexmark.saperion.document.DocumentElementType

Returns the creation date.

getCreationDate() - Method in class com.lexmark.saperion.folder.FolderListItemType

This is the date and time the folder was created.

getCreationDate() - Method in class com.lexmark.saperion.ModificationMetaDataType

This getter gets the date when the resource was created.

getCreationUser() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Returns the creation user.

getCreationUser() - Method in class com.lexmark.saperion.ModificationMetaDataType

This getter gets the user that created the resource.

getCreationUser() - Method in class com.lexmark.saperion.workflow.TaskCommentType

This method returns the user that created the comment.

getCreator() - Method in class com.lexmark.saperion.folder.FolderListItemType

This is a reference to the user that created the folder.

getCurrency() - Method in class com.lexmark.saperion.archive.CurrencyFieldType

Returns the currency symbol(s).

getDdcName() - Method in class com.lexmark.saperion.document.DocumentReferenceType

Returns the ddc name.

getDdcName() - Method in class com.lexmark.saperion.folder.FolderReferenceType

Returns the ddcName.

getDdcName() - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

This getter returns the name of the document definition to find the lookup entry in.

getDefinition(ArchiveReferenceType) - Method in interface com.lexmark.saperion.archive.ArchiveService

Returns detailed information about the archive definition identified by the specified reference.

getDeniedRights() - Method in class com.lexmark.saperion.administration.GroupAccessType

Gets the rights denied to the group.

getDeniedRights() - Method in class com.lexmark.saperion.administration.UserAccessType

Gets the rights denied to the user.

getDescription() - Method in class com.lexmark.saperion.administration.AclListItemType

Returns the access control list's description.

getDescription() - Method in class com.lexmark.saperion.administration.AclPropertiesType

Returns the access control list's description.

getDescription() - Method in class com.lexmark.saperion.administration.AclType

getDescription() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the description.

getDescription() - Method in class com.lexmark.saperion.administration.GroupType

Returns the description.

getDescription() - Method in class com.lexmark.saperion.administration.RoleListItemType

Returns the role's description.

getDescription() - Method in class com.lexmark.saperion.administration.RolePropertiesType

Returns the role's description.

getDescription() - Method in class com.lexmark.saperion.administration.RoleType

getDescription() - Method in class com.lexmark.saperion.administration.TenantListItemType

Returns the tenant's description.

getDescription() - Method in class com.lexmark.saperion.administration.TenantType

This getter gets the description of the tenant.

getDescription() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the description.

getDescription() - Method in class com.lexmark.saperion.administration.UserType

This getter gets the description of the user.

getDescription() - Method in class com.lexmark.saperion.exceptions.ErrorType

Returns the description.

getDescription() - Method in class com.lexmark.saperion.workflow.TaskListItemType

Returns the description of the actual task as defined in the process.

getDescription() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task description.

getDescription() - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Returns the optional transition description.

getDescriptionParameters() - Method in exception com.lexmark.saperion.exceptions.EcmException

Returns the error description parameters.

getDescriptionParameters() - Method in exception com.lexmark.saperion.exceptions.EcmRuntimeException

Returns the error description parameters.

getDescriptionParameters() - Method in class com.lexmark.saperion.exceptions.ErrorType

Returns the parameters.

getDetails() - Method in class com.lexmark.saperion.exceptions.ErrorType

Returns the details.

getDistinguishedName() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the distinguished name.

getDistinguishedName() - Method in class com.lexmark.saperion.administration.GroupType

Returns the distinguished name.

getDistinguishedName() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the distinguished name.

getDistinguishedName() - Method in class com.lexmark.saperion.administration.UserType

Returns the distinguished name.

getDocumentElement() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the document element.

getDocumentElement() - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Returns the document element.

getDocumentElementStoreInformationType(DocumentReferenceType, DocumentRevisionReferenceType, DocumentElementReferenceType) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new DocumentElementStoreInformationType given a reference to the stored document, a reference to the newly created revision and a a reference to the stored element.

getDocumentId() - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

This getter gets a reference to the document this revision belongs to.

getDocumentId() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the document id.

getDocumentReference() - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Returns the document reference.

getDocumentReference() - Method in class com.lexmark.saperion.document.DocumentStoreInformationType

Returns the document reference.

getDocumentReference() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

This getter gets the document reference.

getDocuments() - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method returns a search client for the collection of documents contained in the current folder.

getDocuments() - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

getDocumentService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getDocumentService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client offering document operations.

getDuration() - Method in class com.lexmark.saperion.workflow.TimeInfoType

Returns the task duration.

getElement(DocumentElementReferenceType) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method returns the document element client for the given document element id.

getElement(DocumentElementReferenceType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

getElementReference() - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Returns the element reference.

getEmailAddress() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the emailAddress.

getEmailAddress() - Method in class com.lexmark.saperion.administration.UserType

This getter gets the email address of the user.

getEnumFieldIdentifier() - Method in class com.lexmark.saperion.archive.EnumFieldType

Returns the identifier of the linked field in the enum type definition.

getEnumTypeDefinition() - Method in class com.lexmark.saperion.archive.EnumFieldType

Returns a reference to the archive containing enum entries that is linked to this field.

getErrorCode() - Method in exception com.lexmark.saperion.exceptions.EcmException

Returns the exception error code.

getErrorCode() - Method in exception com.lexmark.saperion.exceptions.EcmRuntimeException

Returns the exception error code.

getErrorCode() - Method in class com.lexmark.saperion.exceptions.ErrorType

Returns the errorCode.

getErrorCode() - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

getErrorCode() - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

getErrorCode() - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Returns the error code this exception mapping applies to.

getErrorCode() - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

getErrorCode() - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.EcmException

Returns the exception error details.

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.EcmRuntimeException

Returns the exception error details.

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.ConcurrentWriteException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.ObjectLockedException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.SystemFieldWriteException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.runtime.WrongArchiveKindException

getErrorDetails() - Method in exception com.lexmark.saperion.exceptions.system.PasswordExpiredException

getEstimatedWorkingTime() - Method in class com.lexmark.saperion.workflow.TimeInfoType

Returns the estimated task working time.

getExceptionMappings() - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

This method returns all exception mappings registered with this factory.

getExceptionMappings() - Method in class com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory

getExceptionMappings() - Method in class com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory

getExceptionMappings() - Method in class com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory

getExpectedArchiveKind() - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

getExtension() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method returns the schema-extension properties of the group.

getExtension() - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method returns the schema-extension properties of the tenant.

getExtension() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method returns the schema-extension properties of the user.

getExtension() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

getExtension() - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

getExtension() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

getFeatures() - Method in class com.lexmark.saperion.archive.ArchiveType

Returns the features contained in this archive.

getField(ArchiveReferenceType, String) - Method in interface com.lexmark.saperion.archive.ArchiveService

Returns the field identified by the specified definition-reference and field-name.

getFieldName() - Method in class com.lexmark.saperion.search.expression.BinaryOperation

getFieldName() - Method in class com.lexmark.saperion.search.expression.UnaryOperation

getFieldOrder() - Method in class com.lexmark.saperion.search.query.Statement

Returns the list of field order descriptors, which prescribe the result set element order.

getFields(ArchiveReferenceType) - Method in interface com.lexmark.saperion.archive.ArchiveService

Returns the fields of the archive definition identified by the specified reference.

getFields() - Method in class com.lexmark.saperion.archive.ArchiveType

Returns the fields of this archive.

getFields() - Method in class com.lexmark.saperion.search.query.Statement

Returns the list of fields that should be selected by the query.

getFieldType() - Method in class com.lexmark.saperion.archive.EnumFieldType

Returns the type of the values contained in this field.

getFieldType() - Method in class com.lexmark.saperion.archive.FieldDefinition

Returns the type of this field.

getFieldType() - Method in class com.lexmark.saperion.archive.ListFieldType

Returns the type of the items contained in this list.

getFieldType() - Method in class com.lexmark.saperion.archive.LookupFieldType

Returns the type of the values contained in this field.

getFileName() - Method in class com.lexmark.saperion.document.FileDocumentElementType

Returns the file name.

getFileNames() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

getFolder(FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method returns the folder given by its reference.

getFolderName() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

The name of a folder identifies it uniquely amongst its siblings.

getFolderService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getFolderService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client offering folder operations.

getFullName() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the fullName.

getFullName() - Method in class com.lexmark.saperion.administration.GroupType

Returns the (full-) name of the group.

getFullName() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the fullName.

getFullName() - Method in class com.lexmark.saperion.administration.UserType

Returns the user name.

getGrantedRights() - Method in class com.lexmark.saperion.administration.GroupAccessType

Gets the rights granted to the group.

getGrantedRights() - Method in class com.lexmark.saperion.administration.UserAccessType

Gets the rights granted to the user.

getGroup() - Method in class com.lexmark.saperion.administration.GroupAccessType

Gets the group reference.

getGroupAccessRights() - Method in class com.lexmark.saperion.administration.AclPropertiesType

getGroupAccessRights() - Method in class com.lexmark.saperion.administration.AclType

getGroupInboxes() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

getGroupInboxes() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method returns a search client for the workflow group inboxes.

getGroupManagementService() - Method in interface com.lexmark.saperion.client.administration.UserAdministrationClient

This method returns a client offering group management functionality.

getGroupManagementService() - Method in class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

getGroupMembers() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method returns the group membership management component for groups for the given group.

getGroupMembers() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

getGuid() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the GUID.

getGuid() - Method in class com.lexmark.saperion.administration.GroupType

Returns the GUID.

getGuid() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the GUID.

getGuid() - Method in class com.lexmark.saperion.administration.UserType

Returns the GUID.

getHash() - Method in class com.lexmark.saperion.document.ContentMetaDataType

getHash() - Method in class com.lexmark.saperion.document.HashDescriptor

getHashAlgorithm() - Method in class com.lexmark.saperion.document.ContentMetaDataType

getHashes() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

getHdoc() - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

Returns the HDOC.

getHdoc() - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

Returns the HDOC.

getHeight() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the height.

getId() - Method in class com.lexmark.saperion.administration.AclReferenceType

This getter returns the id of the referenced access control list.

getId() - Method in class com.lexmark.saperion.administration.ActorReferenceType

Returns the reference id.

getId() - Method in class com.lexmark.saperion.administration.RoleReferenceType

getId() - Method in class com.lexmark.saperion.administration.TenantReferenceType

This method returns the id of the tenant.

getId() - Method in enum com.lexmark.saperion.LicenseEnumeration

getId() - Method in class com.lexmark.saperion.workflow.InboxReferenceType

Returns the inbox id.

getId() - Method in class com.lexmark.saperion.workflow.TaskCommentReferenceType

Returns the reference id.

getId() - Method in class com.lexmark.saperion.workflow.TaskReferenceType

Returns the task reference id.

getId() - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Returns the transition id.

getId() - Method in class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

Returns the workflow process id.

getInbox(InboxReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowInboxService

Returns the inbox with the specified ID.

getInboxClient() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

getInboxClient() - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a client offering functionality concerning workflow inboxes.

getInboxes() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

getInboxes() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method returns a search client for the workflow inboxes.

getIndex() - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Returns the index of the new document.

getIndex() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

The index data are custom attributes to set on the folder.

getIndex() - Method in class com.lexmark.saperion.folder.FolderListItemType

The index data are the generic data of the folder as defined by the archive the folder resides in.

getIndex() - Method in class com.lexmark.saperion.folder.UpdateFolderInputType

Returns the index.

getIndex() - Method in class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

Returns the index.

getIndex() - Method in class com.lexmark.saperion.workflow.TaskPropertyType

Returns the index data of a workflow process.

getIndexData() - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

This getter gets the index data of the document revision.

getIndexData() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the index data.

getIndexData() - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Returns the document index data.

getIndexData() - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

getIndexData() - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

getIndexData() - Method in class com.lexmark.saperion.lookup.LookupEntryListItemType

This getter returns the index data of the lookup entry.

getIndexData(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Returns the task's index data.

getInitialTransition() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

getInitialTransition() - Method in interface com.lexmark.saperion.client.workflow.WorkflowDefinitionClient

This method returns the initial transition definition for the workflow definition.

getInitialTransition(WorkflowDefinitionReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowDefinitionService

This method returns the initial transition definition for the referenced workflow.

getIsolation() - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Returns the isolation type of this archive.

getIsolation() - Method in class com.lexmark.saperion.archive.ArchiveType

Returns the isolation type of this archive.

getItems() - Method in class com.lexmark.saperion.search.SearchResultPage

Returns the item result list.

getLastModificationDate() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Returns the last modification date.

getLastModificationDate() - Method in class com.lexmark.saperion.folder.FolderListItemType

This is the last date and time the folder was updated.

getLastModificationDate() - Method in class com.lexmark.saperion.ModificationMetaDataType

This getter gets the date the resource was last modified.

getLastModificationUser() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Returns the last modification user.

getLastModificationUser() - Method in class com.lexmark.saperion.folder.FolderListItemType

This is a reference to the user who last changed the folder.

getLastModificationUser() - Method in class com.lexmark.saperion.ModificationMetaDataType

This getter gets the user that modified the resource last.

getLatest() - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

getLatestRevisionId(DocumentReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method returns the id of the latest revision of the document given by its id.

getLength() - Method in class com.lexmark.saperion.archive.StringFieldType

Returns the length of this field.

getLinkedDocumentId() - Method in class com.lexmark.saperion.document.LinkDocumentElementType

Returns the linked document id.

getLinkName() - Method in class com.lexmark.saperion.document.LinkDocumentElementType

Returns the link name.

getLiteralType() - Method in class com.lexmark.saperion.search.literal.Literal

Returns the literal type.

getLocked() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Checks if this user's account is locked.

getLockedSince() - Method in class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

getLockUser() - Method in class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

getLookupEntry(LookupEntryReferenceType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

This method returns the lookup entry the given reference references.

getLookupEntryService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getLookupEntryService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client offering lookup entry functionality.

getLookupFieldIdentifier() - Method in class com.lexmark.saperion.archive.LookupFieldType

Returns the identifier of the linked field in the lookup type definition.

getLookupTypeDefinition() - Method in class com.lexmark.saperion.archive.LookupFieldType

Returns a reference to the archive containing lookup entries that is linked to this field.

getMarkColor() - Method in class com.lexmark.saperion.document.MarkerAnnotationType

Returns the mark color.

getMemberIndexPath() - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

Returns the member index path.

getMemberType() - Method in class com.lexmark.saperion.PropertyType

This property is only valid, when the property "type" is FieldTypeEnum.LIST.

getMissingFields() - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

getModificationMetaData() - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

getModificationMetaData() - Method in class com.lexmark.saperion.document.DocumentRevisionType

getModificationMetaData() - Method in class com.lexmark.saperion.lookup.LookupEntryListItemType

This getter gets data about the creation and the last modification of the lookup entry.

getName() - Method in class com.lexmark.saperion.administration.AclListItemType

Returns the access control list's name.

getName() - Method in class com.lexmark.saperion.administration.AclPropertiesType

Returns the access control list's name.

getName() - Method in class com.lexmark.saperion.administration.AclReferenceType

This getter returns the name of the referenced access control list.

getName() - Method in class com.lexmark.saperion.administration.AclType

getName() - Method in class com.lexmark.saperion.administration.ActorListItemType

Returns the actor's full name.

getName() - Method in class com.lexmark.saperion.administration.RoleListItemType

Returns the role's name.

getName() - Method in class com.lexmark.saperion.administration.RolePropertiesType

Returns the role's name.

getName() - Method in class com.lexmark.saperion.administration.RoleType

getName() - Method in class com.lexmark.saperion.administration.TenantListItemType

Returns the tenant's name.

getName() - Method in class com.lexmark.saperion.administration.TenantType

This getter returns the name of the tenant.

getName() - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Returns the name of this archive.

getName() - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

the name of the referenced archive.

getName() - Method in class com.lexmark.saperion.archive.ArchiveType

Returns the name of this archive.

getName() - Method in class com.lexmark.saperion.archive.FieldDefinition

Return the name of the field.

getName() - Method in class com.lexmark.saperion.folder.FolderListItemType

The name of a folder identifies a folder uniquely amongst its siblings.

getName() - Method in class com.lexmark.saperion.search.query.FieldOrderDescriptor

Returns the name.

getName() - Method in class com.lexmark.saperion.workflow.InboxListItemType

Returns the name of the inbox.

getName() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionListItemType

Returns the workflow definition name.

getName() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

This getter returns the name of the workflow definition.

getName() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Returns the name of the workflow definition.

getName() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Returns the process name.

getNegatedExpression() - Method in class com.lexmark.saperion.search.expression.BooleanNotExpression

getNodeType() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

getNodeType() - Method in class com.lexmark.saperion.document.DocumentElementType

Returns the document node type.

getNodeType() - Method in class com.lexmark.saperion.document.LinkDocumentElementType

getNodeType() - Method in class com.lexmark.saperion.document.StructureCompositeDocumentElementType

getNoteText() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the note text.

getOffset() - Method in class com.lexmark.saperion.search.PageDefinition

Returns the offset in the paged collection.

getOperator() - Method in class com.lexmark.saperion.search.expression.BinaryOperation

getOperator() - Method in class com.lexmark.saperion.search.expression.UnaryOperation

getOrder() - Method in class com.lexmark.saperion.search.query.FieldOrderDescriptor

Returns the order.

getOrganizationInboxes() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

getOrganizationInboxes() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method returns a search client for the workflow organization inboxes.

getOwner() - Method in class com.lexmark.saperion.workflow.InboxListItemType

Returns a reference to the owner of this inbox.

getOwner() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Returns the owner of the process.

getPage() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the page.

getPageDefinition() - Method in class com.lexmark.saperion.search.SearchResultPage

getPageSize() - Method in class com.lexmark.saperion.search.PageDefinition

Returns the maximum number of elements in a page.

getParameterProcessor(Object) - Static method in class com.lexmark.saperion.util.BeanToStringUtil

Returns the ToStringParameterPossessor for the given bean.

getParent() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

This reference defines the parent of the folder to create.

getParent() - Method in class com.lexmark.saperion.folder.FolderListItemType

This is a reference to the parent folder of the folder.

getPassword() - Method in class com.lexmark.saperion.administration.CreateUserPropertiesType

Returnt the password.

getPasswordExpiration(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method gets the date when the users password will expire or null if the password never expires.

getPasswordExpiration() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method gets the date when the users password will expire or null if the password never expires.

getPasswordExpiration() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

getPath() - Method in class com.lexmark.saperion.folder.FolderListItemType

The path of the folder is its parent path + \ + its name.

getPersonalInbox() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

getPersonalInbox() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method returns a client for the personal workflow inbox.

getPersonalInbox() - Method in interface com.lexmark.saperion.workflow.WorkflowInboxService

Returns the personal inbox of the current user.

getPrecision() - Method in class com.lexmark.saperion.archive.CurrencyFieldType

getPrecision() - Method in class com.lexmark.saperion.archive.FloatFieldType

Returns the precision of the values contained in this field.

getPresent() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Checks if this user is present.

getPreviewSeparator() - Method in class com.lexmark.saperion.archive.ListFieldType

getPreviousActor() - Method in class com.lexmark.saperion.workflow.TaskType

This getter gets the actor of the task prior to this task.

getPreviousRevisionId() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the previous revision id.

getPriority() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task priority.

getProcess() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task process information.

getProperties(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Returns the task's properties.

getProperty(Object, String) - Static method in class com.lexmark.saperion.util.BeanUtils

Returns the named property value for the given bean.

getProperty(Object, String) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method gets the beans property with the given name.

getPropertyValue() - Method in class com.lexmark.saperion.PropertyType

Returns the property value.

getRawProperty(Object, String) - Static method in class com.lexmark.saperion.util.BeanUtils

Returns the raw named property value for the given bean.

getReceiveDate() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task's receive date.

getRecipientList() - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This getter gets the list of users the recipient(s) can be chosen from.

getRecipientSelection() - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

Returns the recipients selection type of the workflow.

getRecipientSelection() - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

This getter gets if and in what way the next recipient is selected.

getReference() - Method in class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

getReference() - Method in class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

getReference() - Method in class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

getReference() - Method in class com.lexmark.saperion.ListItemType

Returns a reference to the associated object.

getReference() - Method in class com.lexmark.saperion.ResourceType

Returns the resource's object reference.

getRestricted() - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This getter gets whether the recipient selection is restricted to a list of actors or whether the recipient(s) can be chosen freely.

getRevision(DocumentRevisionReferenceType) - Method in interface com.lexmark.saperion.client.document.DocumentClient

This method returns a document revision client bound to the given revision of the given document.

getRevision(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

getRevisionReference() - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Returns the revision reference.

getRevisionReference() - Method in class com.lexmark.saperion.document.DocumentStoreInformationType

Returns the revision reference.

getRevisionReference() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Return a reference to the document for which the workflow was started.

getRevisionTag() - Method in class com.lexmark.saperion.document.DocumentRevisionType

Returns the revision tag.

getRole() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

This getter gets the role to assign to this group.

getRole() - Method in class com.lexmark.saperion.administration.GroupType

This getter gets the role assigned to this group.

getRoleManagementService() - Method in interface com.lexmark.saperion.client.administration.UserAdministrationClient

This method returns a client offering role management functionality.

getRoleManagementService() - Method in class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

getSaperionClientFactory(Map<String, String>, ConnectorFactory) - Static method in interface com.lexmark.saperion.client.SaperionClientFactory

This factory method creates a new saperion client factory given an implementation of ConnectorFactory.

getSchemaExtension(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns the schema-extension for the given group.

getSchemaExtension(TenantReferenceType) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method returns the schema-extension for the given tenant.

getSchemaExtension(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method returns the schema-extension for the given user.

getSearchServiceForDeletedItems() - Method in interface com.lexmark.saperion.administration.TenantManagementService

getShortName() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Returns the shortName.

getShortName() - Method in class com.lexmark.saperion.administration.GroupType

Returns the short-name of the group.

getShortName() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Returns the shortName.

getShortName() - Method in class com.lexmark.saperion.administration.UserType

This getter gets the short name (display name).

getSimpleProperty(Object, String) - Static method in class com.lexmark.saperion.util.BeanUtils

Returns the simple property value for the given bean.

getSingleActorSelection() - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This getter gets whether one and only one recipient has to be selected or a list of recipients.

getState() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Return the workflow state.

getStorageSize() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

getString() - Method in class com.lexmark.saperion.search.literal.DateLiteral

getStructure() - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Returns the structure of the new document.

getSubFolders() - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method returns a collection containing the sub folders of this folder.

getSubFolders() - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

getSubject() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task subject.

getSubstituteAccessAllowed() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Checks if the substitute-access to the user's workflow inbox is enabled.

getSubstituteInboxes() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

getSubstituteInboxes() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method returns a search client for the workflow substitute inboxes.

getSupportedErrors() - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

Returns the supported error codes for this factory instance.

getSynchronizedGroup() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Checks if this group is synchronized with LDAP.

getSynchronizedUser() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Checks if this user is synchronized with LDAP.

getSysRowId() - Method in class com.lexmark.saperion.document.DocumentReferenceType

Returns the SYSROWID.

getSysRowId() - Method in class com.lexmark.saperion.folder.FolderReferenceType

Returns the sysRowId.

getSysRowId() - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

This getter returns the id of the database row the lookup entry represents.

getSystemFieldNames() - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

getTask(TaskReferenceType) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

getTask(TaskReferenceType) - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a client for the workflow task with the provided id.

getTaskReference() - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

getTaskReference() - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

getTasks() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxClientImpl

getTasks() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxClient

This method returns a search client for the task contained in the given inbox.

getTechnicalUser() - Method in class com.lexmark.saperion.administration.UserPropertiesType

Checks if this is a technical user.

getTenant() - Method in class com.lexmark.saperion.administration.UserType

This getter gets a reference to the tenant the user is part of.

getTenantManagementService() - Method in interface com.lexmark.saperion.client.administration.UserAdministrationClient

This method returns a client offering tenant management functionality.

getTenantManagementService() - Method in class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

getTextColor() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the text color.

getTextRotation() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the text rotation.

getTimeInformation() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task time information.

getTimeInformation() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Return the time information for the workflow.

getTotalCount() - Method in class com.lexmark.saperion.workflow.InboxListItemType

Returns the number of items in this inbox.

getTransitions() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

getTransitions() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method returns the task's forward transition definitions.

getTransitions(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Returns the task's transition definitions.

getType() - Method in class com.lexmark.saperion.administration.ActorListItemType

Returns the actor's type.

getType() - Method in class com.lexmark.saperion.administration.ActorReferenceType

Returns the actor type.

getType() - Method in class com.lexmark.saperion.administration.ActorType

Returns the actor type.

getType() - Method in class com.lexmark.saperion.administration.GroupListItemType

getType() - Method in class com.lexmark.saperion.administration.GroupReferenceType

getType() - Method in class com.lexmark.saperion.administration.GroupType

getType() - Method in class com.lexmark.saperion.administration.UserListItemType

getType() - Method in class com.lexmark.saperion.administration.UserReferenceType

getType() - Method in class com.lexmark.saperion.administration.UserType

getType() - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

getType() - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

getType() - Method in class com.lexmark.saperion.exceptions.ErrorDetailsType

Need specification.

getType() - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

getType() - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

getType() - Method in class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

getType() - Method in class com.lexmark.saperion.PropertyType

Returns the property type.

getType() - Method in class com.lexmark.saperion.workflow.InboxListItemType

Returns the type of the inbox.

getType() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Returns the workflow process type.

getTypeName() - Method in class com.lexmark.saperion.archive.FieldType

Returns the name of this FieldType.

getUncompressedSize() - Method in class com.lexmark.saperion.document.ContentMetaDataType

getUnreadCount() - Method in class com.lexmark.saperion.workflow.InboxListItemType

Returns the number of all unread items in this inbox.

getURI() - Method in class com.lexmark.saperion.document.InputStreamReferenceType

Returns the content id.

getUser() - Method in class com.lexmark.saperion.administration.UserAccessType

Gets the user reference.

getUser() - Method in class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

getUserAccessRights() - Method in class com.lexmark.saperion.administration.AclPropertiesType

getUserAccessRights() - Method in class com.lexmark.saperion.administration.AclType

getUserAdministrationService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getUserAdministrationService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client offering tenant, user and group management functionality.

getUserFields() - Method in class com.lexmark.saperion.workflow.TaskType

Returns the task's user fields.

getUserManagementService() - Method in interface com.lexmark.saperion.client.administration.UserAdministrationClient

This method returns a client offering user management functionality.

getUserManagementService() - Method in class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

getUserMembers() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method returns the group membership management component for users for the given group.

getUserMembers() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

getValue() - Method in class com.lexmark.saperion.search.expression.BinaryOperation

getValue() - Method in class com.lexmark.saperion.search.literal.Literal

Returns the value.

getVariables() - Method in class com.lexmark.saperion.document.DocumentElementType

Returns the element variables.

getVersion() - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Returns the version of this archive.

getVersion() - Method in class com.lexmark.saperion.archive.ArchiveType

Returns the version of this archive.

getVersion() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Returns the workflow definition version.

getViolatedFields() - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

getViolations() - Method in class com.lexmark.saperion.exceptions.mappings.ExceptionFactory.IntegrityCheckResult

Returns the integrity check violations.

getWhere() - Method in class com.lexmark.saperion.search.query.Statement

Returns the expression representing the where clause of the query.

getWidth() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the width.

getWorkflowDefinition(String) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

getWorkflowDefinition(WorkflowDefinitionReferenceType) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

getWorkflowDefinition(String) - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a client for the definition with the given name.

getWorkflowDefinition(WorkflowDefinitionReferenceType) - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a client for the workflow definition with the provided id.

getWorkflowDefinition() - Method in class com.lexmark.saperion.workflow.WorkflowProcessListItemType

Returns the workflow definition that is associated with the given workflow process.

getWorkflowDefinition() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow definition for the process.

getWorkflowDefinitionById(WorkflowDefinitionReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowDefinitionService

This method returns further information for a workflow process given by its reference.

getWorkflowErrorCode() - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

getWorkflowPoolEnabled() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Checks if the workflow-pool of this group is enabled.

getWorkflowProcesses() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

getWorkflowProcesses() - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a search client for the workflow processes in the system.

getWorkflowService() - Method in class com.lexmark.saperion.client.implementation.SaperionClientImpl

getWorkflowService() - Method in interface com.lexmark.saperion.client.SaperionClient

This method returns a client offering workflow functionality.

getWorkingTime() - Method in class com.lexmark.saperion.workflow.TimeInfoType

Returns the task working time.

getWorkInPoolAllowed() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Checks if members of this group are allowed to work in the group's pool.

getWriteAttempt() - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

getX() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the x.

getY() - Method in class com.lexmark.saperion.document.AnnotationType

Returns the y.

GroupAccessType - Class in com.lexmark.saperion.administration

Representation of the access rights granted amd denied to a group.

GroupAccessType() - Constructor for class com.lexmark.saperion.administration.GroupAccessType

Default constructor: Creates a new unititalized GroupAccessType instance.

GroupAccessType(GroupReferenceType, Set<AccessRight>, Set<AccessRight>) - Constructor for class com.lexmark.saperion.administration.GroupAccessType

Creates a GroupAccessType instance with the given group and access rights.

GroupAccessType(GroupReferenceType, Set<AccessRight>) - Constructor for class com.lexmark.saperion.administration.GroupAccessType

Creates a GroupAccessType instance with the given group and access rights.

GroupAccessType(GroupReferenceType) - Constructor for class com.lexmark.saperion.administration.GroupAccessType

Creates a GroupAccessType instance with no access rights.

GroupClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating a given group.

GroupClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of GroupClient.

GroupClientImpl(GroupManagementService, GroupReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

GroupListItemType - Class in com.lexmark.saperion.administration

List item type for group entities.

GroupListItemType() - Constructor for class com.lexmark.saperion.administration.GroupListItemType

Default constructor.

GroupListItemType(GroupReferenceType) - Constructor for class com.lexmark.saperion.administration.GroupListItemType

Creates a group list item instance with the given group reference.

GroupManagementService - Interface in com.lexmark.saperion.administration

The group management service provides the required operations to create, read, update and delete group entities in the user management system.

GroupManagementServiceClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating groups.

GroupManagementServiceClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of GroupManagementServiceClient.

GroupManagementServiceClientImpl(GroupManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

GroupMembershipClientForGroups - Interface in com.lexmark.saperion.client.administration

This client provides methods to administrate memberships to a given group.

GroupMembershipClientForGroupsImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of GroupMembershipClientForGroups.

GroupMembershipClientForGroupsImpl(GroupManagementService, SearchExecutionService<GroupListItemType>, GroupReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForGroupsImpl

GroupMembershipClientForUsers - Interface in com.lexmark.saperion.client.administration

This client provides methods to administrate memberships to a given group.

GroupMembershipClientForUsersImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of GroupMembershipClientForUsers.

GroupMembershipClientForUsersImpl(GroupManagementService, SearchExecutionService<UserListItemType>, GroupReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForUsersImpl

GroupPropertiesType - Class in com.lexmark.saperion.administration

Data transfer object for group properties.

GroupPropertiesType() - Constructor for class com.lexmark.saperion.administration.GroupPropertiesType

groupReferenceFromId(int) - Static method in class com.lexmark.saperion.TypeConversions

This factory method create a new group reference given a group id.

GroupReferenceType - Class in com.lexmark.saperion.administration

The group reference type.

GroupReferenceType() - Constructor for class com.lexmark.saperion.administration.GroupReferenceType

GroupType - Class in com.lexmark.saperion.administration

The group type is a representation of an user group in the ECM system.

GroupType() - Constructor for class com.lexmark.saperion.administration.GroupType

Creates a new empty group bean.

H

handleNegation(BooleanNotExpression, ResultType) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

hashCode() - Method in class com.lexmark.saperion.administration.AclReferenceType

hashCode() - Method in class com.lexmark.saperion.administration.ActorReferenceType

hashCode() - Method in class com.lexmark.saperion.administration.RoleReferenceType

hashCode() - Method in class com.lexmark.saperion.administration.TenantReferenceType

hashCode() - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

hashCode() - Method in class com.lexmark.saperion.archive.CurrencyFieldType

hashCode() - Method in class com.lexmark.saperion.archive.EnumFieldType

hashCode() - Method in class com.lexmark.saperion.archive.FieldDefinition

hashCode() - Method in class com.lexmark.saperion.archive.FieldType

hashCode() - Method in class com.lexmark.saperion.archive.FloatFieldType

hashCode() - Method in class com.lexmark.saperion.archive.ListFieldType

hashCode() - Method in class com.lexmark.saperion.archive.LookupFieldType

hashCode() - Method in class com.lexmark.saperion.archive.StringFieldType

hashCode() - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

hashCode() - Method in class com.lexmark.saperion.document.DocumentReferenceType

hashCode() - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

hashCode() - Method in class com.lexmark.saperion.exceptions.ErrorCodeType

hashCode() - Method in class com.lexmark.saperion.folder.FolderReferenceType

hashCode() - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

hashCode() - Method in class com.lexmark.saperion.PropertyType

hashCode() - Method in class com.lexmark.saperion.workflow.InboxReferenceType

hashCode() - Method in class com.lexmark.saperion.workflow.TaskCommentReferenceType

hashCode() - Method in class com.lexmark.saperion.workflow.TaskReferenceType

hashCode() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

hashCode() - Method in class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

HashDescriptor - Class in com.lexmark.saperion.document

This class connects the hash of a document with its algorithm name.

HashDescriptor() - Constructor for class com.lexmark.saperion.document.HashDescriptor

hasNext() - Method in class com.lexmark.saperion.search.SearchResultIterator

I

IllegalInputError(int) - Constructor for class com.lexmark.saperion.exceptions.runtime.IllegalRequestException.IllegalInputError

Creates a new error with the given error value.

IllegalRequestException - Exception in com.lexmark.saperion.exceptions.runtime

Exception that represents errors due to illegal client inputs.

IllegalRequestException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Exception factory constructor.

IllegalRequestException(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given exception message.

IllegalRequestException(String, Exception) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given exception message.

IllegalRequestException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error details, exception cause and exception message.

IllegalRequestException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given exception cause.

IllegalRequestException(IllegalRequestException.IllegalInputError) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error code.

IllegalRequestException(IllegalRequestException.IllegalInputError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

IllegalRequestException(IllegalRequestException.IllegalInputError, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error code, error details, exception cause and exception message.

IllegalRequestException(IllegalRequestException.IllegalInputError, String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error code and exception message.

IllegalRequestException(IllegalRequestException.IllegalInputError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.IllegalRequestException

Creates a new exception with the given error code and exception cause.

IllegalRequestException.IllegalInputError - Class in com.lexmark.saperion.exceptions.runtime

Error code implementation for security exceptions.

InboxListItemType - Class in com.lexmark.saperion.workflow

A InboxListItemType holds the most important information about a workflow-inbox.

InboxListItemType() - Constructor for class com.lexmark.saperion.workflow.InboxListItemType

Constructs a new InboxListItemType with an empty inbox resource reference.

InboxListItemType(InboxReferenceType) - Constructor for class com.lexmark.saperion.workflow.InboxListItemType

Constructs a new InboxListItemType.

InboxReferenceType - Class in com.lexmark.saperion.workflow

This ReferenceType identifies workflow-inboxes.

InboxReferenceType() - Constructor for class com.lexmark.saperion.workflow.InboxReferenceType

InboxTypeEnumeration - Enum in com.lexmark.saperion.workflow

This enumeration contains the possible types of workflow-inboxes.

InconsistentExceptionFactoryRegistryException - Exception in com.lexmark.saperion.exceptions.mappings

This exception indicates that the ecms client exception mapper is configured inconsistently.

InconsistentExceptionFactoryRegistryException(String) - Constructor for exception com.lexmark.saperion.exceptions.mappings.InconsistentExceptionFactoryRegistryException

initCause(Throwable, Throwable) - Static method in class com.lexmark.saperion.util.BeanUtils

Initialized the cause of a throwable.

InputStreamReferenceType - Class in com.lexmark.saperion.document

InputStream reference that identifies a document content stream.

InputStreamReferenceType() - Constructor for class com.lexmark.saperion.document.InputStreamReferenceType

Creates a new input stream reference.

InputStreamReferenceType(URI) - Constructor for class com.lexmark.saperion.document.InputStreamReferenceType

Creates a new input stream reference with the given id.

IntegerFieldType - Class in com.lexmark.saperion.archive

This FieldType contains integer values.

IntegerFieldType() - Constructor for class com.lexmark.saperion.archive.IntegerFieldType

Creates a new IntegerFieldType.

IntegrityCheckResult(boolean) - Constructor for class com.lexmark.saperion.exceptions.mappings.ExceptionFactory.IntegrityCheckResult

Creates an integrity check result.

INTERNAL_ERROR_OFFSET - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

INTERNAL_SERVER_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

InternalServerError - Exception in com.lexmark.saperion.exceptions.runtime

Internal server error.

InternalServerError() - Constructor for exception com.lexmark.saperion.exceptions.runtime.InternalServerError

Constructs a new internal server error.

InternalServerError(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.InternalServerError

Deserialization constructor.

InternalServerError(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.InternalServerError

Constructs a new internal server error.

InternalServerError(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.InternalServerError

Constructs a new internal server error.

InternalServerError(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.InternalServerError

Constructs a new internal server error.

interpret(ExpressionContext) - Method in class com.lexmark.saperion.search.literal.Literal

Interprets a literal and resolves its value.

isAdministrationAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isAdministrationAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isApplicationError(int) - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

isAsIcon() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the asIcon flag.

isChunkedOnMedium() - Method in class com.lexmark.saperion.document.FileDocumentElementType

Returns the cunkedOnMedium flag.

isClientError(int) - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

isColdFrame() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the cold frame.

isCommentRequired() - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Defines if a comment must be provided on a task forward operation.

isConfigureAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isConfigureAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isDeleted() - Method in class com.lexmark.saperion.administration.AclListItemType

isDeleted() - Method in class com.lexmark.saperion.administration.AclType

isDeleted() - Method in class com.lexmark.saperion.administration.ActorListItemType

Checks if this actor is deleted.

isDeleted() - Method in class com.lexmark.saperion.administration.ActorType

Checks if this actor is deleted.

isDeleted() - Method in class com.lexmark.saperion.administration.RoleListItemType

isDeleted() - Method in class com.lexmark.saperion.administration.RoleType

isDeleted() - Method in class com.lexmark.saperion.administration.TenantListItemType

Checks if this tenant is deleted.

isDeleted() - Method in class com.lexmark.saperion.administration.TenantType

Checks if this tenant is deleted.

isDisplayAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isDisplayAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isEditAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isEditAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isHasMoreItems() - Method in class com.lexmark.saperion.search.SearchResultPage

isImportAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isImportAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isIndexingAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isIndexingAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isLine() - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Returns the line.

isLocked() - Method in class com.lexmark.saperion.administration.UserType

Checks if this user's account is locked.

isOriginalFormat() - Method in class com.lexmark.saperion.document.FileDocumentElementType

Returns the original format flag.

isOverlay() - Method in class com.lexmark.saperion.document.PictureAnnotationType

Returns the overlay flag.

isPicture() - Method in class com.lexmark.saperion.document.FileDocumentElementType

Returns the isPicture flag.

isPresent() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Checks if this group is present.

isPresent() - Method in class com.lexmark.saperion.administration.GroupType

Checks if this group is present.

isPresent() - Method in class com.lexmark.saperion.administration.UserType

Checks if the user is present.

isQueryAllowed() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isQueryAllowed() - Method in class com.lexmark.saperion.administration.RoleType

isRead() - Method in class com.lexmark.saperion.workflow.TaskListItemType

Returns whether this task was already read or not.

isReadOnly() - Method in class com.lexmark.saperion.archive.FieldDefinition

Checks if this field is read-only.

isRecipientRequired() - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This getter gets whether a recipient is required for the workflow step.

isRequired() - Method in class com.lexmark.saperion.archive.FieldDefinition

Checks if this field is required.

isSecurityError(int) - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

isSsoUser() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isSsoUser() - Method in class com.lexmark.saperion.administration.RoleType

isSubstituteAccessAllowed() - Method in class com.lexmark.saperion.administration.UserType

Checks if the substitute-access to the user's workflow inbox is enabled.

isSuperAdministrator() - Method in class com.lexmark.saperion.administration.RolePropertiesType

isSuperAdministrator() - Method in class com.lexmark.saperion.administration.RoleType

isSynchronizedGroup() - Method in class com.lexmark.saperion.administration.GroupType

Checks if this group is synchronized with LDAP.

isSynchronizedUser() - Method in class com.lexmark.saperion.administration.UserType

Checks if this user is synchronized with LDAP.

isSystemError(int) - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

isSystemField() - Method in class com.lexmark.saperion.archive.FieldDefinition

Checks if this field is a system-field.

isTechnicalUser() - Method in class com.lexmark.saperion.administration.UserType

Checks if this is a technical user.

isTenantSpecific() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Returns the workflow tenant property.

isTransparent() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the transparent.

isUnicode() - Method in class com.lexmark.saperion.archive.StringFieldType

Checks whether this field contains unicode-strings or not.

isUnique() - Method in class com.lexmark.saperion.archive.FieldDefinition

Checks if this field is unique.

isValid() - Method in class com.lexmark.saperion.exceptions.mappings.ExceptionFactory.IntegrityCheckResult

Returns true if the integrity check succeeded.

isWordWrap() - Method in class com.lexmark.saperion.document.TextAnnotationType

Returns the word wrap.

isWorkflowPoolEnabled() - Method in class com.lexmark.saperion.administration.GroupType

Checks if the workflow-pool of this group is enabled.

isWorkInPoolAllowed() - Method in class com.lexmark.saperion.administration.GroupType

Checks if members of this group are allowed to work in the group's pool.

L

latestRevision() - Method in interface com.lexmark.saperion.client.document.DocumentClient

This method returns a document revision client bound to the newest revision of the given document.

latestRevision() - Method in class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

LICENSE_CLAIM - Static variable in class com.lexmark.saperion.TokenConstants

Name of the claim that contains the requested license in a JWT.

LicenseEnumeration - Enum in com.lexmark.saperion

This enumeration holds saperion id types.

LinkDocumentElementType - Class in com.lexmark.saperion.document

This DocumentElementType represents a link to another document.

LinkDocumentElementType() - Constructor for class com.lexmark.saperion.document.LinkDocumentElementType

list(Statement, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(List<String>, Expression, List<FieldOrderDescriptor>, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(List<String>, Expression, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(Expression, List<FieldOrderDescriptor>, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(Expression, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(Expression) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list() - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

list(Statement, PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

list(List<String>, Expression, List<FieldOrderDescriptor>, PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

list(List<String>, Expression, PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

list(Expression, List<FieldOrderDescriptor>, PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

list(Expression, PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search paging as defined.

list(Expression) - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the filtered result of the search using the default paging.

list() - Method in interface com.lexmark.saperion.client.SearchClient

This method returns an iterable over the complete result of the search using the default paging.

list(SearchExecutionService<ItemType>) - Static method in class com.lexmark.saperion.search.SearchResultIterator

list(SearchExecutionService<ItemType>, Statement, PageDefinition) - Static method in class com.lexmark.saperion.search.SearchResultIterator

ListFieldType - Class in com.lexmark.saperion.archive

This FieldType contains a list of values.

ListFieldType() - Constructor for class com.lexmark.saperion.archive.ListFieldType

Creates a new ListFieldType.

ListItemType<T extends ReferenceType> - Class in com.lexmark.saperion

An list item is a flyweight representation of a backend object.

ListItemType(T) - Constructor for class com.lexmark.saperion.ListItemType

Default list item constructor.

listPropertyFromValue(Collection<?>) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new list property by determining the element type from the first list element.

Literal<T> - Class in com.lexmark.saperion.search.literal

Literals represent base date type nodes in the abstract syntax tree.

Literal(T) - Constructor for class com.lexmark.saperion.search.literal.Literal

Creates a literal with the given value.

load() - Method in interface com.lexmark.saperion.client.administration.AclClient

This method loads the access control list.

load() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method loads the group.

load() - Method in interface com.lexmark.saperion.client.administration.RoleClient

This method loads the role.

load() - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method loads the tenant.

load() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method loads the user entity from the user management system.

load() - Method in interface com.lexmark.saperion.client.archive.ArchiveClient

This method loads the archive this client is bound to from the backend.

load() - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method loads a document revision with its content.

load() - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method returns the properties of the specified folder.

load() - Method in class com.lexmark.saperion.client.implementation.administration.AclClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxClientImpl

load() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

load() - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method loads the lookup entry instance.

load() - Method in interface com.lexmark.saperion.client.workflow.WorkflowDefinitionClient

This method returns a representation of the workflow definition.

load() - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxClient

This method reads the properties of the given inbox.

load() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method returns the task's properties.

loadAcl(AclReferenceType) - Method in interface com.lexmark.saperion.administration.AclManagementService

This method returns an access control list with the given id.

loadAclByName(String) - Method in interface com.lexmark.saperion.administration.AclManagementService

Loads an access control list identified by its name.

loadConnectorFactory() - Static method in interface com.lexmark.saperion.client.spi.ConnectorFactory

This method is a convenience method to retrieve an implementation of this service interface using the java service loader.

loadContent() - Method in interface com.lexmark.saperion.client.document.DocumentElementClient

This method Opens the content of the document element identified by the given id for reading and returns an input stream for that data.

loadContent() - Method in class com.lexmark.saperion.client.implementation.document.DocumentElementClientImpl

loadDocument(DocumentRevisionReferenceType, LoadKindEnumeration) - Method in interface com.lexmark.saperion.document.DocumentService

Loads a complete document revision given its revision id.

loadDocument(DocumentReferenceType, LoadKindEnumeration) - Method in interface com.lexmark.saperion.document.DocumentService

Loads the latest document revision with the given document id.

loadGroup(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method loads a group given a reference to it.

loadGroupByName(String) - Method in interface com.lexmark.saperion.administration.GroupManagementService

loadGroups(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method returns the groups the given user is a member of.

LoadKindEnumeration - Enum in com.lexmark.saperion.document

This enumeration holds the different ways a document can be loaded.

loadMetadata() - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method loads a document revision without its content.

loadMetadata() - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

loadProcess(WorkflowProcessReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowProcessService

Loads the details of a workflow process with the given reference.

loadPropertiesFromFile(String) - Static method in class com.lexmark.saperion.util.ConfigurationUtils

This method loads configuration properties from a file in java-properties-format.

loadRole(RoleReferenceType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

This method returns a role with the given id.

loadRoleByName(String) - Method in interface com.lexmark.saperion.administration.RoleManagementService

Loads a role identified by its name.

loadTenant(TenantReferenceType) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method returns a tenant given its id.

loadTenant(String) - Method in interface com.lexmark.saperion.administration.TenantManagementService

Loads a tenant identified by its name.

loadUser(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

Load the user entity identified by the given user reference from the user management system.

loadUserByName(String) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method loads a user given by name.

loadWorkflowProcess(WorkflowProcessReferenceType) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

loadWorkflowProcess(WorkflowProcessReferenceType) - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method loads a workflow process.

lock() - Method in interface com.lexmark.saperion.client.document.DocumentClient

This method locks the document.

lock() - Method in class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

lockDocument(DocumentReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method locks a document for the current user..

LookupEntryClient - Interface in com.lexmark.saperion.client.lookup

This client provides functionality for reading and modifying a given lookup entry.

LookupEntryClientImpl - Class in com.lexmark.saperion.client.implementation.lookup

This is the default implementation of LookupEntryClient.

LookupEntryClientImpl(LookupEntryService, LookupEntryReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

LookupEntryListItemType - Class in com.lexmark.saperion.lookup

A LookupEntryType represents an entry in a lookup table.

LookupEntryListItemType() - Constructor for class com.lexmark.saperion.lookup.LookupEntryListItemType

This constructor creates a new empty lookup index type.

LookupEntryLockedDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details of a ObjectLockedException concerning lookup-entries.

LookupEntryLockedDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

lookupEntryReferenceFromDatabase(String, String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new LookupEntryReferenceType for a given DDC name and SYSROWID.

LookupEntryReferenceType - Class in com.lexmark.saperion.lookup

A LookupEntryReferenceType is an id that identifies an entry in a lookup table.

LookupEntryReferenceType() - Constructor for class com.lexmark.saperion.lookup.LookupEntryReferenceType

LookupEntryService - Interface in com.lexmark.saperion.lookup

Implementations of this class hold core functionality concerning lookup tables.

LookupEntryServiceClient - Interface in com.lexmark.saperion.client.lookup

This client provides functionality concerning lookup entries.

LookupEntryServiceClientImpl - Class in com.lexmark.saperion.client.implementation.lookup

This is the default implementation of LookupEntryServiceClient.

LookupEntryServiceClientImpl(LookupEntryService) - Constructor for class com.lexmark.saperion.client.implementation.lookup.LookupEntryServiceClientImpl

LookupFieldType - Class in com.lexmark.saperion.archive

This FieldType contains values that can be retrieved from a lookup table.

LookupFieldType() - Constructor for class com.lexmark.saperion.archive.LookupFieldType

Creates a new LookupFieldType.

LookupFieldType(FieldTypeEnum) - Constructor for class com.lexmark.saperion.archive.LookupFieldType

Creates a new EnumFieldType with the specified type name.

LookupListFieldType - Class in com.lexmark.saperion.archive

This FieldType contains a list of values that can be retrieved from a lookup table.

LookupListFieldType() - Constructor for class com.lexmark.saperion.archive.LookupListFieldType

Creates a new LookupListFieldType.

M

MalformedEntityException - Exception in com.lexmark.saperion.exceptions.application

This exception indicates that an entity was encountered whose data is in some way malformed or inconsistent.

MalformedEntityException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.MalformedEntityException

This is the constructor used for serialization.

MalformedEntityException(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.MalformedEntityException

This constructor creates a new malformed-entity-exception.

MalformedEntityException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.MalformedEntityException

This constructor creates a new malformed-entity-exception.

MalformedEntityException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.MalformedEntityException

This constructor creates a new malformed-entity-exception.

MandatoryConstraintViolationDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details for MandatoryConstraintViolationException.

MandatoryConstraintViolationDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

MandatoryConstraintViolationException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that an create or update operation violated an mandatory constraint.

MandatoryConstraintViolationException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationException

This is the constructor used for serialization.

MandatoryConstraintViolationException(ArchiveReferenceType, List<String>, Map<String, PropertyType>) - Constructor for exception com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationException

MarkerAnnotationType - Class in com.lexmark.saperion.document

This annotation indicates a marker.

MarkerAnnotationType() - Constructor for class com.lexmark.saperion.document.MarkerAnnotationType

merge(Bean, Bean, Bean) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method merges the given changes to the given bean to the target bean.

merge(Bean, Bean) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method merges the given changes to the given bean.

ModificationMetaDataType - Class in com.lexmark.saperion

This simple bean holds information about teh creation and last modification of a resource.

ModificationMetaDataType() - Constructor for class com.lexmark.saperion.ModificationMetaDataType

moveFolder(FolderReferenceType) - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method moves a folder to another parent.

moveFolder(FolderReferenceType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

moveFolder(FolderReferenceType, FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method moves the given folder to the given target.

MULTIPART_REFERENCE_TYPE_NAME - Static variable in class com.lexmark.saperion.document.InputStreamReferenceType

N

name(ErrorCodeType) - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

Returns the name for the given error code constant.

name(Class<?>, Object) - Static method in class com.lexmark.saperion.util.ConstantUtils

Inspects a constant definition class and returns the constant's name.

newAclManagementService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new acl management service.

newArchiveSearch() - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a search client for the archives available in the system.

newArchiveSearch() - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

newArchiveService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new archive service.

newBackendConfigurationException(String, Throwable, Map<String, String>) - Static method in class com.lexmark.saperion.exceptions.system.BackendSystemException.BackendExceptionFactory

Creates a new exception for backend configuration errors.

newClient(String, String, LicenseEnumeration, String) - Method in class com.lexmark.saperion.client.implementation.SaperionClientFactoryImpl

newClient(String, String, LicenseEnumeration) - Method in class com.lexmark.saperion.client.implementation.SaperionClientFactoryImpl

newClient(String, String, LicenseEnumeration, String) - Method in interface com.lexmark.saperion.client.SaperionClientFactory

This method creates a new saperion client with a new session in the context of the given user credentials.

newClient(String, String, LicenseEnumeration) - Method in interface com.lexmark.saperion.client.SaperionClientFactory

This method creates a new saperion client with a new session in the context of the given user credentials.

newConnector(Map<String, String>) - Method in class com.lexmark.saperion.client.ConnectorFactoryImpl

newConnector(Map<String, String>) - Method in interface com.lexmark.saperion.client.spi.ConnectorFactory

This method creates a new connector configured by the given configuration properties.

newConnector() - Method in interface com.lexmark.saperion.client.spi.ConnectorFactory

This method creates a new connector configured by with default configuration properties.

newConnector(Properties) - Method in interface com.lexmark.saperion.client.spi.ConnectorFactory

This method creates a new connector configured by the given configuration properties.

newContainedDocumentSearchService(FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method returns a search execution service that lists the documents contained in the given folder.

newContainedFolderSearchService(FolderReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method creates a new search execution service that lists the directly contained folders of the folder given.

newDocumentElementStoreInformationType(DocumentStoreInformationType, DocumentElementReferenceType) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new DocumentElementStoreInformationType given a document store information type and an element reference.

newDocumentSearch(ArchiveReferenceType) - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a search client for documents in the archive.

newDocumentSearch(ArchiveReferenceType) - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

newDocumentService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new document service.

newDocumentStoreInformationType(String, String, String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new DocumentStoreInformationType for the given values.

newFolderSearch(ArchiveReferenceType) - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a search client for folders in the archive.

newFolderSearch(ArchiveReferenceType) - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

newFolderSearchService(ArchiveReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method creates a new search execution service that all folders in a folder archive.

newFolderService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method create a new folder service.

newGroupManagementService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new group management service.

newInboxTypeSearchService(InboxTypeEnumeration) - Method in interface com.lexmark.saperion.workflow.WorkflowInboxService

This method returns a search execution service that searches all inboxes of a specific type.

newInstance(Map<String, String>) - Static method in interface com.lexmark.saperion.client.SaperionClientFactory

This static factory method uses the connector factory spi to create a new client factory.

newInstance(String) - Static method in class com.lexmark.saperion.document.InputStreamReferenceType

Creates a new input stream reference from the given id.

newListPropertyType(Object, FieldTypeEnum) - Static method in class com.lexmark.saperion.Properties

This factory method for property types creates list properties.

newLookupEntrySearch(ArchiveReferenceType) - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a search client for lookup entries in the archive.

newLookupEntrySearch(ArchiveReferenceType) - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

newLookupEntryService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new lookup entry service.

newMembershipSearchServiceForGroups(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns a search execution service that searches groups that are members of the given group.

newMembershipSearchServiceForUsers(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns a search execution service that searches users that are members of the given group.

newMultiValueFieldSearchService(DocumentRevisionReferenceType, String) - Method in interface com.lexmark.saperion.document.DocumentService

This method creates a new search service that searches in the values that are set on the given multi value field for the given document.

newMultiValueFieldSearchService(FolderReferenceType, String) - Method in interface com.lexmark.saperion.folder.FolderService

This method creates a new search service that searches in the values that are set on the given multi value field for the given folder.

newMultiValueFieldSearchService(LookupEntryReferenceType, String) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

This method creates a new search service that searches in the values that are set on the given multi value field for the given lookup entry.

newPageDefinition(int, int) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new PageDefinition with the given offset and size.

newPropertyType(Object, FieldTypeEnum) - Static method in class com.lexmark.saperion.Properties

This is the literal factory method for property types.

newPropertyType(Collection<?>) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.LIST with the given value.

newPropertyType(Date) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.DATETIME with the given value.

newPropertyType(Boolean) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.BOOLEAN with the given value.

newPropertyType(Number) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property with the given value.

newPropertyType(String) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.STRING with the given value.

newPropertyType(Date) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.DATE with the given value.

newPropertyType(Time) - Static method in class com.lexmark.saperion.Properties

This factory method creates a new property of type FieldTypeEnum.TIME with the given value.

newRoleManagementService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new role management service.

newSearchService(ArchiveReferenceType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

This method creates a new search service that searches lookup entries in the given archive.

newTaskSearchService(InboxReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowInboxService

This method creates an new search execution service that searches tasks that are contained in the referenced workflow inbox.

newTenantAclSearchService() - Method in interface com.lexmark.saperion.administration.AclManagementService

This method returns a new SearchExecutionService that lists all access control lists of the current user's tenant.

newTenantDeletedAclSearchService() - Method in interface com.lexmark.saperion.administration.AclManagementService

This method returns a new SearchExecutionService that lists all deleted access control lists of the current user's tenant.

newTenantDeletedGroupSearchService() - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns a search execution service that searches deleted groups of the current user's tenant.

newTenantDeletedRoleSearchService() - Method in interface com.lexmark.saperion.administration.RoleManagementService

This method returns a new SearchExecutionService that lists all deleted roles of the current user's tenant.

newTenantDeletedUserSearchService() - Method in interface com.lexmark.saperion.administration.UserManagementService

This method returns a new search execution service that lists all deleted users of the current user's tenant.

newTenantGroupSearchService() - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method returns a search execution service that searches groups of the current user's tenant.

newTenantManagementService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new tenant management service.

newTenantRoleSearchService() - Method in interface com.lexmark.saperion.administration.RoleManagementService

This method returns a new SearchExecutionService that lists all roles of the current user's tenant.

newTenantUserSearchService() - Method in interface com.lexmark.saperion.administration.UserManagementService

This method returns a new search execution service that lists all users of the current user's tenant.

newUserManagementService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new user management service.

newWorkflowDefinitionReference(String) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new WorkflowDefinitionReferenceType given its name.

newWorkflowDefinitionService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new workflow definition service.

newWorkflowInboxService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new workflow inbox service.

newWorkflowProcessService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method create a new workflow process service.

newWorkflowTaskService() - Method in interface com.lexmark.saperion.client.spi.ServiceFactory

This method creates a new workflow task service.

next() - Method in class com.lexmark.saperion.search.SearchResultIterator

noUserSelectionRequired() - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new RecipientSelectionType indicating that no user selection is required.

NumericLiteral<T extends Number> - Class in com.lexmark.saperion.search.literal

The numeric literal implements the required functionality to represent literals that extend from Number.

NumericLiteral(T) - Constructor for class com.lexmark.saperion.search.literal.NumericLiteral

Constructs a numeric literal with the given value.

O

ObjectLockedDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details of ObjectLockedException.

ObjectLockedDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

ObjectLockedException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that an operation tried to modify an object that is currently locked.

ObjectLockedException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ObjectLockedException

This is the constructor used for serialization.

ObjectLockedException(ReferenceType) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ObjectLockedException

This constructor creates a new object locked exception that indicates that the object referenced by the given reference is locked.

ObjectLockedException(ReferenceType, UserListItemType, Date) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ObjectLockedException

This constructor creates a new object locked exception that indicates that the object referenced by the given reference is locked.

P

page(PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

page(int, int) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

page(PageDefinition) - Method in interface com.lexmark.saperion.client.SearchClient

This method retrieves the given page of the result of the search.

page(int, int) - Method in interface com.lexmark.saperion.client.SearchClient

This method retrieves the given page of the result of the search.

PageDefinition - Class in com.lexmark.saperion.search

The collection page parameter defines a specific section in the collection result set which is returned by the collection's list method.

PageDefinition() - Constructor for class com.lexmark.saperion.search.PageDefinition

Default constructor.

PageDefinition(int, int) - Constructor for class com.lexmark.saperion.search.PageDefinition

Constructs a new paging parameter with the given page offset and number of elements per page.

parseDate(String) - Static method in class com.lexmark.saperion.search.literal.DateLiteral

Parses a Date literal value from a string.

parseDateTime(String) - Static method in class com.lexmark.saperion.search.literal.DateLiteral

Parses a Date literal value from a string.

parseFloat(String) - Static method in class com.lexmark.saperion.search.literal.NumericLiteral

Parses a float literal value from a string.

parseInteger(String) - Static method in class com.lexmark.saperion.search.literal.NumericLiteral

Parses a integer literal value from a string.

parseTime(String) - Static method in class com.lexmark.saperion.search.literal.DateLiteral

Parses a Time literal value from a string.

PasswordExpiredDetails - Class in com.lexmark.saperion.exceptions.system

These are the details of PasswordExpiredException.

PasswordExpiredDetails() - Constructor for class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

PasswordExpiredException - Exception in com.lexmark.saperion.exceptions.system

This SecurityException indicates that the password of the current user expired.

PasswordExpiredException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.PasswordExpiredException

Exception factory constructor.

PasswordExpiredException(UserReferenceType) - Constructor for exception com.lexmark.saperion.exceptions.system.PasswordExpiredException

PictureAnnotationType - Class in com.lexmark.saperion.document

This annotation holds a picture.

PictureAnnotationType() - Constructor for class com.lexmark.saperion.document.PictureAnnotationType

populate(Object, Map<String, ? extends Object>) - Static method in class com.lexmark.saperion.util.BeanUtils

Populates a bean with the given values.

Properties - Class in com.lexmark.saperion

This utility class holds convenience factories for properties.

PROPERTY_SAPERION_CONNECTION_TYPE - Static variable in class com.lexmark.saperion.client.ConnectorFactoryImpl

PropertyType - Class in com.lexmark.saperion

Bean that represents a typed property of an ecm-service entity.

PropertyType() - Constructor for class com.lexmark.saperion.PropertyType

Default constructor.

PropertyType(FieldTypeEnum, Object) - Constructor for class com.lexmark.saperion.PropertyType

Creates a new instance with the given values.

PropertyType(FieldTypeEnum, FieldTypeEnum, Object) - Constructor for class com.lexmark.saperion.PropertyType

Creates a new instance with the given values.

propertyTypeFromValue(Object) - Static method in class com.lexmark.saperion.Properties

This convenience factory method analyzes the class of given value and returns a PropertyType with the given value and an appropriate type.

PropertyUtils - Class in com.lexmark.saperion.util

Utility class to interface with common property utilities.

PROTOCOL_INCOMPATIBLE_VERSION - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

PROTOCOL_MISSING_VERSION - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

R

read() - Method in class com.lexmark.saperion.document.InputStreamReferenceType

readDocumentElementContent(DocumentRevisionReferenceType, DocumentElementReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

Opens the content of the document element identified by the given id for reading and returns an input stream for that data.

RecipientSelectionType - Class in com.lexmark.saperion.workflow

A recipient selection holds the information if and how the user for a workflow step has to be selected by in the previous workflow step.

RecipientSelectionType() - Constructor for class com.lexmark.saperion.workflow.RecipientSelectionType

ReferenceType - Class in com.lexmark.saperion

The reference type represents an object reference to arbitrary resources in the ECM system.

ReferenceType() - Constructor for class com.lexmark.saperion.ReferenceType

remove() - Method in class com.lexmark.saperion.search.SearchResultIterator

removeDocument(DocumentReferenceType) - Method in interface com.lexmark.saperion.client.folder.FolderDocumentSearchServiceClient

This method deletes the referenced document from the given folder.

removeDocument(DocumentReferenceType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderDocumentSearchServiceClientImpl

removeDocument(FolderReferenceType, DocumentReferenceType) - Method in interface com.lexmark.saperion.folder.FolderService

This method removes the given document from the given folder.

removeGroupMember(GroupReferenceType, ActorReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method removes a member reference to the given group.

removeMember(GroupReferenceType) - Method in interface com.lexmark.saperion.client.administration.GroupMembershipClientForGroups

This method removes a member reference from the given group.

removeMember(UserReferenceType) - Method in interface com.lexmark.saperion.client.administration.GroupMembershipClientForUsers

This method removes a member reference from the given group.

removeMember(GroupReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForGroupsImpl

removeMember(UserReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupMembershipClientForUsersImpl

resolve(AclReferenceType) - Method in interface com.lexmark.saperion.client.administration.AclManagementServiceClient

This method returns an administration client for the access control list with the given reference.

resolve(GroupReferenceType) - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method returns an administration client for the group with the given reference.

resolve(RoleReferenceType) - Method in interface com.lexmark.saperion.client.administration.RoleManagementServiceClient

This method returns an administration client for the role with the given reference.

resolve(TenantReferenceType) - Method in interface com.lexmark.saperion.client.administration.TenantManagementClient

This method returns a client capable to administrate the tenant with the given reference.

resolve(UserReferenceType) - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method returns an administration client for the user referenced.

resolve(ArchiveReferenceType) - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a client for the archive referenced.

resolve(DocumentReferenceType) - Method in interface com.lexmark.saperion.client.document.DocumentServiceClient

This method returns a client for the document referenced.

resolve(DocumentRevisionReferenceType) - Method in interface com.lexmark.saperion.client.document.DocumentServiceClient

This method returns a client for the document revision referenced.

resolve(FolderReferenceType) - Method in interface com.lexmark.saperion.client.folder.FolderServiceClient

This method returns a client for the folder referenced.

resolve(AclReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

resolve(GroupReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

resolve(RoleReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

resolve(TenantReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

resolve(UserReferenceType) - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

resolve(ArchiveReferenceType) - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

resolve(DocumentReferenceType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentServiceClientImpl

resolve(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentServiceClientImpl

resolve(FolderReferenceType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderServiceClientImpl

resolve(LookupEntryReferenceType) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryServiceClientImpl

resolve(InboxReferenceType) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

resolve(LookupEntryReferenceType) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryServiceClient

This method returns a client for the lookup entry referenced.

resolve(InboxReferenceType) - Method in interface com.lexmark.saperion.client.workflow.WorkflowInboxServiceClient

This method gets a client for a workflow inbox given its reference.

resolveName(String) - Method in interface com.lexmark.saperion.client.administration.AclManagementServiceClient

This method returns an administration client for the access control list with the given name.

resolveName(String) - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method returns an administration client for the group with the given name.

resolveName(String) - Method in interface com.lexmark.saperion.client.administration.RoleManagementServiceClient

This method returns an administration client for the role with the given name.

resolveName(String) - Method in interface com.lexmark.saperion.client.administration.TenantManagementClient

This method returns a client capable to administrate the tenant with the given name.

resolveName(String) - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method returns an administration client for the user with the given name.

resolveName(String) - Method in interface com.lexmark.saperion.client.archive.ArchiveServiceClient

This method returns a client for the archive with the given name.

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

resolveName(String) - Method in class com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

resolveVariable(String) - Method in class com.lexmark.saperion.search.context.ExpressionContext

Resolves a variable name to its value.

resolveVariable(String) - Method in class com.lexmark.saperion.search.context.SimpleExpressionContext

ResourceNotFoundException - Exception in com.lexmark.saperion.exceptions.runtime

Exception that represents errors due to illegal client inputs.

ResourceNotFoundException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException

Exception factory constructor.

ResourceNotFoundException(String) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException

Creates a new exception with the given exception message.

ResourceNotFoundException(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException

Creates a new exception with the given error details, exception cause and exception message.

ResourceNotFoundException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException

Creates a new exception with the given exception cause.

ResourceType<T extends ReferenceType> - Class in com.lexmark.saperion

The class resource type is the base type for all beans that a represent REST resource.

ResourceType(T) - Constructor for class com.lexmark.saperion.ResourceType

Constructs a new resource instance.

restrictedUserSelection(boolean, List<ActorListItemType<? extends ActorReferenceType>>) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new RecipientSelectionType indicating that user selection is required and restricted to the given list of actors.

revokeOwnership() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

revokeOwnership() - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method revokes the ownership of the task from the current user.

revokeOwnership(TaskReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Revokes the ownership of a task.

RoleClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating a given role.

RoleClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of RoleClient.

RoleClientImpl(RoleManagementService, RoleReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

RoleListItemType - Class in com.lexmark.saperion.administration

List item type for role entities.

RoleListItemType() - Constructor for class com.lexmark.saperion.administration.RoleListItemType

Default constructor.

RoleListItemType(RoleReferenceType) - Constructor for class com.lexmark.saperion.administration.RoleListItemType

Creates a role list item instance with the given role reference.

RoleManagementService - Interface in com.lexmark.saperion.administration

The role management service provides the required operations to create, read, update and delete role entities in the user management system.

RoleManagementServiceClient - Interface in com.lexmark.saperion.client.administration

This client provides methods for administrating rolea.

RoleManagementServiceClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of RoleManagementServiceClient.

RoleManagementServiceClientImpl(RoleManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

RolePropertiesType - Class in com.lexmark.saperion.administration

Data transfer object for role properties.

RolePropertiesType() - Constructor for class com.lexmark.saperion.administration.RolePropertiesType

roleReferenceFromId(int) - Static method in class com.lexmark.saperion.TypeConversions

This method creates a new RoleReferenceType with the given ID.

RoleReferenceType - Class in com.lexmark.saperion.administration

This ReferenceType references a role.

RoleReferenceType() - Constructor for class com.lexmark.saperion.administration.RoleReferenceType

RoleType - Class in com.lexmark.saperion.administration

The RoleType is a representation of a role in the user management.

RoleType() - Constructor for class com.lexmark.saperion.administration.RoleType

RuntimeExceptionFactory - Class in com.lexmark.saperion.exceptions.mappings

ECMS runtime exception factory implementation.

RuntimeExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory

RuntimeExceptionFactory.RuntimeErrors - Enum in com.lexmark.saperion.exceptions.mappings

Runtime error definitions.

S

SaperionClient - Interface in com.lexmark.saperion.client

The saperion client provides a client interface for the saperion functionality.

SaperionClientFactory - Interface in com.lexmark.saperion.client

Ths saperion client factory works as an entry point for saperion functionality.

SaperionClientFactoryImpl - Class in com.lexmark.saperion.client.implementation

This is the default implementation of SaperionClientFactory.

SaperionClientFactoryImpl(Connector) - Constructor for class com.lexmark.saperion.client.implementation.SaperionClientFactoryImpl

SaperionClientImpl - Class in com.lexmark.saperion.client.implementation

This is the default implementation of SaperionClient.

SaperionClientImpl(ServiceFactory) - Constructor for class com.lexmark.saperion.client.implementation.SaperionClientImpl

SaperionConnectionType - Enum in com.lexmark.saperion.client

This enumeration holds the different configuration values defined for connecting to a saperion system.

ScannedDocumentElementType - Class in com.lexmark.saperion.document

This document element indicates that the current document represents a scanned page.

ScannedDocumentElementType() - Constructor for class com.lexmark.saperion.document.ScannedDocumentElementType

search(Statement, PageDefinition) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method lists all tenants in the system.

search(Statement, PageDefinition) - Method in interface com.lexmark.saperion.archive.ArchiveService

Returns a list of basic information about all archive definitions in the system.

search() - Method in interface com.lexmark.saperion.client.administration.AclManagementServiceClient

This method returns a search client for searching access control lists.

search() - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method returns a search client for searching groups.

search() - Method in interface com.lexmark.saperion.client.administration.RoleManagementServiceClient

This method returns a search client for searching roles.

search() - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method returns a search client for searching users.

search() - Method in class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

search() - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

search() - Method in class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

search() - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

search(Statement, PageDefinition) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

search(Statement, PageDefinition) - Method in interface com.lexmark.saperion.search.SearchExecutionService

Returns the result page for a query execution with custom paging/fetch window size.

search(Statement, PageDefinition) - Method in interface com.lexmark.saperion.workflow.WorkflowDefinitionService

This method returns a list of references for every workflow definition in the system accessible from the current tenant.

search(Statement, PageDefinition) - Method in interface com.lexmark.saperion.workflow.WorkflowInboxService

This method returns a list of information about all inboxes of the current user.

SEARCH_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SEARCH_RUNTIME_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SEARCH_STATEMENT_EXECUTION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SEARCH_STATEMENT_SYNTAX_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SearchClient<ItemType> - Interface in com.lexmark.saperion.client

This is the client-side interface for searches.

SearchClientImpl<ItemType> - Class in com.lexmark.saperion.client.implementation

This is the default implementation of SearchClient.

SearchClientImpl(SearchExecutionService<ItemType>) - Constructor for class com.lexmark.saperion.client.implementation.SearchClientImpl

searchDeleted() - Method in interface com.lexmark.saperion.client.administration.AclManagementServiceClient

This method returns a search client for searching deleted access control lists.

searchDeleted() - Method in interface com.lexmark.saperion.client.administration.GroupManagementServiceClient

This method returns a search client for searching deleted groups.

searchDeleted() - Method in interface com.lexmark.saperion.client.administration.RoleManagementServiceClient

This method returns a search client for searching deleted roles.

searchDeleted() - Method in interface com.lexmark.saperion.client.administration.TenantManagementClient

This method returns a new SearchClient that can be used to search for deleted tenants.

searchDeleted() - Method in interface com.lexmark.saperion.client.administration.UserManagementServiceClient

This method returns a search client for searching deleted users.

searchDeleted() - Method in class com.lexmark.saperion.client.implementation.administration.AclManagementServiceClientImpl

searchDeleted() - Method in class com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl

searchDeleted() - Method in class com.lexmark.saperion.client.implementation.administration.RoleManagementServiceClientImpl

searchDeleted() - Method in class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

searchDeleted() - Method in class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

SearchError(int) - Constructor for class com.lexmark.saperion.exceptions.application.SearchException.SearchError

Creates a new error with the given error value.

SearchException - Exception in com.lexmark.saperion.exceptions.application

This exception indicates an error in a search.

SearchException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchException

Default constructor used by serialization methods.

SearchException(SearchException.SearchError, String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchException

Creates a new exception with the given error code, error details, exception cause and exception message.

SearchException(SearchException.SearchError, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchException

Creates a new exception with the given error code, error details, exception cause and exception message.

SearchException(SearchException.SearchError, String, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchException

Creates a new exception with the given error code, error details, exception cause and exception message.

SearchException(SearchException.SearchError, String) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchException

Creates a new exception with the given error code, error details, exception cause and exception message.

SearchException.SearchError - Class in com.lexmark.saperion.exceptions.application

Error code implementation for database query exceptions.

SearchExecutionService<T> - Interface in com.lexmark.saperion.search

A search execution service implements a specific server-side search operation.

searchMultiValueField(String) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method returns a search client for the content of the given multi value field of the given document revision.

searchMultiValueField(String) - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method returns a search client for the content of the given multi value field of the given folder.

searchMultiValueField(String) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

searchMultiValueField(String) - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

searchMultiValueField(String) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

searchMultiValueField(String) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method returns a search client for the content of the given multi value field of the given lookup entry.

SearchResultIterator<T> - Class in com.lexmark.saperion.search

The search result iterator allows to iterate seamlessly over huge result sets.

SearchResultIterator(SearchExecutionService<T>, Statement, PageDefinition) - Constructor for class com.lexmark.saperion.search.SearchResultIterator

SearchResultPage<T> - Class in com.lexmark.saperion.search

Data structure that contains a list of query result items.

SearchResultPage() - Constructor for class com.lexmark.saperion.search.SearchResultPage

SearchRuntimeException - Exception in com.lexmark.saperion.exceptions.runtime

This client exception indicates that a search failed in a context where checked exceptions are prohibited.

SearchRuntimeException(String, EcmException) - Constructor for exception com.lexmark.saperion.exceptions.runtime.SearchRuntimeException

Creates a new exception with the given exception cause and exception message.

SearchRuntimeException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.SearchRuntimeException

Creates a new exception with the given error code and exception cause.

searchServiceForDefinition(ArchiveReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method returns a search service for the given definition.

SearchStatementExecutionException - Exception in com.lexmark.saperion.exceptions.application

This exception indicates that an error occurred while executing a search statement.

SearchStatementExecutionException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchStatementExecutionException

Default constructor used by serialization methods.

SearchStatementExecutionException(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchStatementExecutionException

Creates an exception for the given message and cause.

SearchStatementExecutionException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchStatementExecutionException

Creates an exception for the given message.

SearchStatementSyntaxException - Exception in com.lexmark.saperion.exceptions.application

This exception indicates that a syntactically wrong Statement was given.

SearchStatementSyntaxException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchStatementSyntaxException

Creates a new query syntax exception.

SearchStatementSyntaxException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.SearchStatementSyntaxException

Default constructor used by serialization methods.

searchWorkflowDefinitions() - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

searchWorkflowDefinitions() - Method in interface com.lexmark.saperion.client.workflow.WorkflowServiceClient

This method returns a resource client for the workflow definition collection.

SECURITY_ACCESS_DENIED - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_ERROR_OFFSET - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_TOKEN_EXPIRED - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_TOKEN_INCONSISTENT - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_TOKEN_INVALID - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SECURITY_TOKEN_UNKNOWN - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SecurityAnnotationType - Class in com.lexmark.saperion.document

This annotation prohibits access to a part of the document.

SecurityAnnotationType() - Constructor for class com.lexmark.saperion.document.SecurityAnnotationType

SecurityError(int) - Constructor for class com.lexmark.saperion.exceptions.system.SecurityException.SecurityError

Creates a new error with the given error value.

SecurityException - Exception in com.lexmark.saperion.exceptions.system

Security base exception.

SecurityException() - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Default constuctor.

SecurityException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Exception factory constructor.

SecurityException(SystemException.SystemError) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code.

SecurityException(SystemException.SystemError, String) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code and exception message.

SecurityException(String) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given exception message.

SecurityException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error details, exception cause and exception message.

SecurityException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given exception cause.

SecurityException(SecurityException.SecurityError) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code.

SecurityException(SecurityException.SecurityError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

SecurityException(SecurityException.SecurityError, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code, error details, exception cause and exception message.

SecurityException(SecurityException.SecurityError, String) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code and exception message.

SecurityException(SecurityException.SecurityError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SecurityException

Creates a new exception with the given error code and exception cause.

SecurityException.SecurityError - Class in com.lexmark.saperion.exceptions.system

Error code implementation for security exceptions.

ServiceFactory - Interface in com.lexmark.saperion.client.spi

This factory is an entry point for the low level service api.

setAccessData(AnnotationAccessDataType) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the access data.

setAclName(String) - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Sets the acl name.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.administration.AclPropertiesType

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the ACLs to set on the group.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the ACLs to set on the user.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Sets the ACLs of the new document.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Sets the ACLs that will replace the existing ACLs on the document.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.folder.CreateFolderInputType

Sets the ACLs to set on the new folder.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.folder.UpdateFolderInputType

Sets the ACLs to set on the folder.

setAcls(List<AclReferenceType>) - Method in class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

Sets the ACLs.

setActor(ActorListItemType<? extends ActorReferenceType>) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task actor.

setActualArchiveKind(ArchiveContentEnum) - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

setAdministrationAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setAdministrationAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setAlgorithmName(String) - Method in class com.lexmark.saperion.document.HashDescriptor

setAnnotations(List<AnnotationType>) - Method in class com.lexmark.saperion.document.ContentDocumentElementType

Sets the annotations.

setArchive(ArchiveReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

setArchive(ArchiveReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

setArchive(ArchiveReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

setArchive(ArchiveReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

setArchiveReference(ArchiveReferenceType) - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Sets the archive reference for the document create operation.

setArchiveReference(ArchiveReferenceType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the definition reference.

setArchiveReference(ArchiveReferenceType) - Method in class com.lexmark.saperion.folder.CreateFolderInputType

This setter sets the archiveReference.

setArchiveReference(ArchiveReferenceType) - Method in class com.lexmark.saperion.lookup.CreateLookupEntryInputType

setArrowColor(int) - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Sets the arrow color.

setArrowWidth(int) - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Sets the arrow width.

setAsIcon(boolean) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the asIcon flag.

setCapabilities(Set<TaskCapabilitiesEnum>) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task capabilities.

setChildren(List<? extends DocumentElementType>) - Method in class com.lexmark.saperion.document.StructureCompositeDocumentElementType

Sets the document element children.

setChildren(List<TaskCommentType>) - Method in class com.lexmark.saperion.workflow.TaskCommentType

Sets a list of sub-comments to this comment.

setChunkedOnMedium(boolean) - Method in class com.lexmark.saperion.document.FileDocumentElementType

Sets the cunkedOnMedium flag.

setCode(int) - Method in class com.lexmark.saperion.exceptions.ErrorCodeType

Sets the bean error code.

setCode(int) - Method in class com.lexmark.saperion.exceptions.ErrorConstantType

Implementation not supported by constant error codes.

setColdFrame(boolean) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the cold frame.

setColor(int) - Method in class com.lexmark.saperion.document.SecurityAnnotationType

Sets the color.

setColor(int) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the color.

setComment(String) - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Sets the comment for the new revision.

setComment(String) - Method in class com.lexmark.saperion.workflow.TaskCommentType

Sets the current comment's value.

setCommentRequired(boolean) - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Sets the comment required flag.

setComments(List<TaskCommentType>) - Method in class com.lexmark.saperion.workflow.TaskPropertyType

Sets the comments to a workflow process.

setCompressedSize(long) - Method in class com.lexmark.saperion.document.ContentMetaDataType

setCompressedSize(Long) - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

setConfigureAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setConfigureAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setContent(InputStream) - Method in class com.lexmark.saperion.document.ContentDocumentElementType

Sets the content.

setContentMetaData(ContentMetaDataType) - Method in class com.lexmark.saperion.document.ContentDocumentElementType

setContentMetaData(DocumentContentMetaDataType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

setContentSize(Long) - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

setContentType(ArchiveContentEnum) - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

Sets the type of content contained in this archive.

setCreateDate(Date) - Method in class com.lexmark.saperion.workflow.TaskCommentType

This method sets the date of creation.

setCreateDate(Date) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the create date of the process.

setCreationDate(Date) - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Sets the creation date.

setCreationDate(Date) - Method in class com.lexmark.saperion.document.DocumentElementType

Sets the creation date.

setCreationDate(Date) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the date and time the folder was created.

setCreationDate(Date) - Method in class com.lexmark.saperion.ModificationMetaDataType

This setter sets the date when the resource was created.

setCreationUser(long) - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Sets the creationUser.

setCreationUser(UserListItemType) - Method in class com.lexmark.saperion.ModificationMetaDataType

This setter sets the user that created the resource.

setCreationUser(ActorListItemType<UserReferenceType>) - Method in class com.lexmark.saperion.workflow.TaskCommentType

This method sets the user that created the comment.

setCreator(UserReferenceType) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the reference to the user that created the folder.

setCurrency(String) - Method in class com.lexmark.saperion.archive.CurrencyFieldType

Sets the currency symbol(s).

setDdcName(String) - Method in class com.lexmark.saperion.document.DocumentReferenceType

Sets the ddc name.

setDdcName(String) - Method in class com.lexmark.saperion.folder.FolderReferenceType

Sets the ddcName.

setDdcName(String) - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

This setter sets the name of the document definition to find the lookup entry in.

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.AclListItemType

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.AclType

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.ActorListItemType

Marks this actor as deleted.

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.ActorType

Marks this actor as deleted.

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.RoleListItemType

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.TenantListItemType

Marks this tenant as deleted.

setDeleted(boolean) - Method in class com.lexmark.saperion.administration.TenantType

Marks this tenant as deleted.

setDeniedRights(Set<AccessRight>) - Method in class com.lexmark.saperion.administration.GroupAccessType

Sets the rights denied to the group.

setDeniedRights(Set<AccessRight>) - Method in class com.lexmark.saperion.administration.UserAccessType

Sets the rights denied to the user.

setDescription(String) - Method in class com.lexmark.saperion.administration.AclListItemType

Sets the access control list's description.

setDescription(String) - Method in class com.lexmark.saperion.administration.AclPropertiesType

Sets the access control lists description.

setDescription(String) - Method in class com.lexmark.saperion.administration.AclType

setDescription(String) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the description.

setDescription(String) - Method in class com.lexmark.saperion.administration.GroupType

Sets the description.

setDescription(String) - Method in class com.lexmark.saperion.administration.RoleListItemType

Sets the role's description.

setDescription(String) - Method in class com.lexmark.saperion.administration.RolePropertiesType

Sets the roles description.

setDescription(String) - Method in class com.lexmark.saperion.administration.RoleType

setDescription(String) - Method in class com.lexmark.saperion.administration.TenantListItemType

Sets the tenant's description.

setDescription(String) - Method in class com.lexmark.saperion.administration.TenantType

This setter sets the description of the tenant.

setDescription(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the description.

setDescription(String) - Method in class com.lexmark.saperion.administration.UserType

This setter sets the description of the user.

setDescription(String) - Method in class com.lexmark.saperion.exceptions.ErrorType

Sets the description.

setDescription(String) - Method in class com.lexmark.saperion.workflow.TaskListItemType

Sets the description of the actual task as defined in the process.

setDescription(String) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task description.

setDescription(String) - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Sets the description for the transition definition.

setDescriptionParameters(Map<String, String>) - Method in class com.lexmark.saperion.exceptions.ErrorType

Sets the error description parameters.

setDetails(ErrorDetailsType) - Method in class com.lexmark.saperion.exceptions.ErrorType

Sets the details.

setDisplayAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setDisplayAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setDistinguishedName(String) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the distinguished name.

setDistinguishedName(String) - Method in class com.lexmark.saperion.administration.GroupType

Sets the distinguished name.

setDistinguishedName(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the distinguished name.

setDistinguishedName(String) - Method in class com.lexmark.saperion.administration.UserType

Sets the distinguished name.

setDocumentElement(DocumentElementType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the document element.

setDocumentElement(DocumentElementType) - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Sets the document element.

setDocumentId(DocumentReferenceType) - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

This setter sets the reference to the document this revision belongs to.

setDocumentId(DocumentReferenceType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the document id.

setDocumentReference(DocumentReferenceType) - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Sets the document reference.

setDocumentReference(DocumentReferenceType) - Method in class com.lexmark.saperion.document.DocumentStoreInformationType

Sets the document reference.

setDocumentReference(DocumentReferenceType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

This setter sets the document reference.

setDuration(int) - Method in class com.lexmark.saperion.workflow.TimeInfoType

Sets the task duration.

setEditAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setEditAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setElementReference(DocumentElementReferenceType) - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Sets the element reference.

setEmailAddress(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the emailAddress.

setEmailAddress(String) - Method in class com.lexmark.saperion.administration.UserType

This setter sets the email address of the user.

setEnumFieldIdentifier(String) - Method in class com.lexmark.saperion.archive.EnumFieldType

Sets the identifier of the linked field in the enum type definition.

setEnumTypeDefinition(ArchiveReferenceType) - Method in class com.lexmark.saperion.archive.EnumFieldType

Sets the reference to the archive containing enum entries that is linked to this field.

setErrorCode(ErrorCodeType) - Method in class com.lexmark.saperion.exceptions.ErrorType

Sets the errorCode.

setEstimatedWorkingTime(int) - Method in class com.lexmark.saperion.workflow.TimeInfoType

Sets the estimated task working time.

setExpectedArchiveKind(ArchiveContentEnum) - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

setExtension(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method sets the schema-extension properties of the group.

setExtension(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method sets the schema-extension properties of the tenant.

setExtension(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.administration.UserClient

This method sets the schema-extension properties of the user.

setExtension(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

setExtension(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

setExtension(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

setFeatures(Set<ArchiveFeatureEnum>) - Method in class com.lexmark.saperion.archive.ArchiveType

Sets the features supported by this archive.

setFieldName(String) - Method in class com.lexmark.saperion.search.expression.BinaryOperation

setFieldName(String) - Method in class com.lexmark.saperion.search.expression.UnaryOperation

setFieldOrder(List<FieldOrderDescriptor>) - Method in class com.lexmark.saperion.search.query.Statement

Sets the list of field order descriptors, which prescribe the result set element order.

setFields(List<FieldDefinition>) - Method in class com.lexmark.saperion.archive.ArchiveType

Sets the fields of this archive.

setFields(List<String>) - Method in class com.lexmark.saperion.search.query.Statement

Sets list of fields that should be selected by the query.

setFieldType(FieldType) - Method in class com.lexmark.saperion.archive.EnumFieldType

Sets the type of the values contained in this field.

setFieldType(FieldType) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets the type of this field.

setFieldType(FieldType) - Method in class com.lexmark.saperion.archive.ListFieldType

Sets the type of the items contained in this list.

setFieldType(FieldType) - Method in class com.lexmark.saperion.archive.LookupFieldType

Sets the type of the values contained in this field.

setFileName(File) - Method in class com.lexmark.saperion.document.FileDocumentElementType

Sets the file name.

setFileNames(List<File>) - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

setFolderName(String) - Method in class com.lexmark.saperion.folder.CreateFolderInputType

This setter sets the name of the folder.

setFullName(String) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the fullName.

setFullName(String) - Method in class com.lexmark.saperion.administration.GroupType

Sets the (full-) name of the group.

setFullName(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the fullName.

setFullName(String) - Method in class com.lexmark.saperion.administration.UserType

Sets the user name.

setGrantedRights(Set<AccessRight>) - Method in class com.lexmark.saperion.administration.GroupAccessType

Sets the rights granted to the group.

setGrantedRights(Set<AccessRight>) - Method in class com.lexmark.saperion.administration.UserAccessType

Sets the rights granted to the user.

setGroup(GroupReferenceType) - Method in class com.lexmark.saperion.administration.GroupAccessType

Sets the group reference.

setGroupAccessRights(List<GroupAccessType>) - Method in class com.lexmark.saperion.administration.AclPropertiesType

setGroupAccessRights(List<GroupAccessType>) - Method in class com.lexmark.saperion.administration.AclType

setGuid(String) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the GUID.

setGuid(String) - Method in class com.lexmark.saperion.administration.GroupType

Sets the GUID.

setGuid(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the GUID.

setGuid(String) - Method in class com.lexmark.saperion.administration.UserType

Sets the GUID.

setHash(byte[]) - Method in class com.lexmark.saperion.document.ContentMetaDataType

setHash(byte[]) - Method in class com.lexmark.saperion.document.HashDescriptor

setHashAlgorithm(String) - Method in class com.lexmark.saperion.document.ContentMetaDataType

setHashes(List<HashDescriptor>) - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

setHasMoreItems(boolean) - Method in class com.lexmark.saperion.search.SearchResultPage

setHdoc(String) - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

Sets the HDOC.

setHdoc(String) - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

Sets the HDOC.

setHeight(short) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the height.

setId(int) - Method in class com.lexmark.saperion.administration.AclReferenceType

This setter sets the id of the referenced access control list.

setId(int) - Method in class com.lexmark.saperion.administration.ActorReferenceType

Sets the reference id.

setId(int) - Method in class com.lexmark.saperion.administration.RoleReferenceType

setId(int) - Method in class com.lexmark.saperion.administration.TenantReferenceType

This method sets the id of the tenant.

setId(Integer) - Method in class com.lexmark.saperion.workflow.InboxReferenceType

Sets the inbox id.

setId(int) - Method in class com.lexmark.saperion.workflow.TaskCommentReferenceType

Sets the reference id.

setId(String) - Method in class com.lexmark.saperion.workflow.TaskReferenceType

Sets the task reference id.

setId(int) - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

Sets the transition id.

setId(String) - Method in class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

Sets the workflow process id.

setImportAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setImportAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Sets the index of the new document.

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.folder.CreateFolderInputType

This setter sets the index data.

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the generic index data of the folder as defined by the archive the folder resides in.

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.folder.UpdateFolderInputType

Sets the index.

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

Sets the index.

setIndex(Map<String, PropertyType>) - Method in class com.lexmark.saperion.workflow.TaskPropertyType

Sets the index data of a workflow process.

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

This setter sets the index data of the document revision.

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the index data.

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

Sets the document index data.

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

setIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.lookup.LookupEntryListItemType

This setter sets the index data of the lookup entry.

setIndexingAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setIndexingAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setIsolation(ArchiveIsolationEnum) - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Sets the isolation type of this archive.

setIsolation(ArchiveIsolationEnum) - Method in class com.lexmark.saperion.archive.ArchiveType

Sets the isolation type of this archive.

setIsOverlay(boolean) - Method in class com.lexmark.saperion.document.PictureAnnotationType

Sets the overlay flag.

setItems(List<T>) - Method in class com.lexmark.saperion.search.SearchResultPage

setLastModificationDate(Date) - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Sets the last modification date.

setLastModificationDate(Date) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the last date and time the folder was updated.

setLastModificationDate(Date) - Method in class com.lexmark.saperion.ModificationMetaDataType

This setter sets the date the resource was last modified.

setLastModificationUser(long) - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

Sets the last modification user.

setLastModificationUser(UserReferenceType) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the uid of the user who last changed the folder.

setLastModificationUser(UserListItemType) - Method in class com.lexmark.saperion.ModificationMetaDataType

This setter sets the user that modified the resource last.

setLatest(ReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

setLength(int) - Method in class com.lexmark.saperion.archive.StringFieldType

Sets the length of this field.

setLine(boolean) - Method in class com.lexmark.saperion.document.ArrowAnnotationType

Sets the line.

setLinkedDocumentId(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.document.LinkDocumentElementType

Sets the linked document id.

setLinkName(String) - Method in class com.lexmark.saperion.document.LinkDocumentElementType

Sets the link name.

SetLiteral<T> - Class in com.lexmark.saperion.search.literal

This Literal represents set literals.

SetLiteral(Set<Literal<T>>) - Constructor for class com.lexmark.saperion.search.literal.SetLiteral

Creates a literal with the given value.

setLocked(Boolean) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the locked-property.

setLocked(boolean) - Method in class com.lexmark.saperion.administration.UserType

Sets the locked-property.

setLockedSince(Date) - Method in class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

setLockUser(UserListItemType) - Method in class com.lexmark.saperion.exceptions.runtime.ObjectLockedDetails

setLookupFieldIdentifier(String) - Method in class com.lexmark.saperion.archive.LookupFieldType

Sets the identifier of the linked field in the lookup type definition.

setLookupTypeDefinition(ArchiveReferenceType) - Method in class com.lexmark.saperion.archive.LookupFieldType

Sets the reference to the archive containing lookup entries that is linked to this field.

setMarkColor(int) - Method in class com.lexmark.saperion.document.MarkerAnnotationType

Sets the mark color.

setMemberIndexPath(int[]) - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

Sets the member index path.

setMemberType(FieldTypeEnum) - Method in class com.lexmark.saperion.PropertyType

This property is only valid, when the property "type" is FieldTypeEnum.LIST.

setMissingFields(List<String>) - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

setModificationMetaData(ModificationMetaDataType) - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

setModificationMetaData(ModificationMetaDataType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

setModificationMetaData(ModificationMetaDataType) - Method in class com.lexmark.saperion.lookup.LookupEntryListItemType

This setter sets data about the creation and the last modification of the lookup entry.

setName(String) - Method in class com.lexmark.saperion.administration.AclListItemType

Sets the access control list's name.

setName(String) - Method in class com.lexmark.saperion.administration.AclPropertiesType

Sets the access control list's name.

setName(String) - Method in class com.lexmark.saperion.administration.AclReferenceType

This setter sets the name of the referenced access control list.

setName(String) - Method in class com.lexmark.saperion.administration.AclType

setName(String) - Method in class com.lexmark.saperion.administration.ActorListItemType

Sets the actor's full name.

setName(String) - Method in class com.lexmark.saperion.administration.RoleListItemType

Sets the role's name.

setName(String) - Method in class com.lexmark.saperion.administration.RolePropertiesType

Sets the role's name.

setName(String) - Method in class com.lexmark.saperion.administration.RoleType

setName(String) - Method in class com.lexmark.saperion.administration.TenantListItemType

Sets the tenant's name.

setName(String) - Method in class com.lexmark.saperion.administration.TenantType

This setter sets the name of the tenant.

setName(String) - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Sets the name of this archive.

setName(String) - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

the name of the referenced archive.

setName(String) - Method in class com.lexmark.saperion.archive.ArchiveType

Sets the name of this archive.

setName(String) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets the name of the field.

setName(String) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the name of the folder.

setName(String) - Method in class com.lexmark.saperion.workflow.InboxListItemType

Sets the name of the inbox.

setName(String) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionListItemType

Sets the workflow definition name.

setName(String) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

This setter sets the name of the workflow definition.

setName(String) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Sets the name of the workflow definition.

setName(String) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow name.

setNegatedExpression(Expression) - Method in class com.lexmark.saperion.search.expression.BooleanNotExpression

setNoteText(String) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the note text.

setOffset(int) - Method in class com.lexmark.saperion.search.PageDefinition

Sets the offset in the paged collection.

setOperator(BinaryOperation.Operator) - Method in class com.lexmark.saperion.search.expression.BinaryOperation

setOperator(UnaryOperation.Operator) - Method in class com.lexmark.saperion.search.expression.UnaryOperation

setOriginalFormat(boolean) - Method in class com.lexmark.saperion.document.FileDocumentElementType

Sets the original format flag.

setOwner(ActorReferenceType) - Method in class com.lexmark.saperion.workflow.InboxListItemType

Sets the reference to the owner of this inbox.

setOwner(UserListItemType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the owner of the workflow.

setPage(short) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the page.

setPageDefinition(PageDefinition) - Method in class com.lexmark.saperion.search.SearchResultPage

setPageSize(int) - Method in class com.lexmark.saperion.search.PageDefinition

Sets the maximum number of elements in a page.

setParent(FolderReferenceType) - Method in class com.lexmark.saperion.folder.CreateFolderInputType

This setter sets the parent folder reference.

setParent(FolderReferenceType) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets reference to the parent folder of the folder.

setPassword(String) - Method in class com.lexmark.saperion.administration.CreateUserPropertiesType

Sets the password.

setPath(String) - Method in class com.lexmark.saperion.folder.FolderListItemType

This setter sets the path of the folder.

setPicture(boolean) - Method in class com.lexmark.saperion.document.FileDocumentElementType

Sets the isPicture flag.

setPrecision(int) - Method in class com.lexmark.saperion.archive.CurrencyFieldType

This operation is not supported on CurrencyField instances.

setPrecision(int) - Method in class com.lexmark.saperion.archive.FloatFieldType

Sets the precision of the values contained in this field.

setPresent(boolean) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the present-property of this group.

setPresent(boolean) - Method in class com.lexmark.saperion.administration.GroupType

Sets the present-property of this group.

setPresent(Boolean) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the present-property of the user.

setPresent(boolean) - Method in class com.lexmark.saperion.administration.UserType

Sets the present-property of the user.

setPreviewSeparator(char) - Method in class com.lexmark.saperion.archive.ListFieldType

setPreviousActor(ActorListItemType<? extends ActorReferenceType>) - Method in class com.lexmark.saperion.workflow.TaskType

This setter sets the actor of the task prior to this task.

setPreviousRevisionId(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the previous revision id.

setPriority(int) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task priority.

setProcess(WorkflowProcessType) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task process information.

setProperty(Object, String, Object) - Static method in class com.lexmark.saperion.util.BeanUtils

Sets the named property on the given bean.

setProperty(Object, String, Object) - Static method in class com.lexmark.saperion.util.PropertyUtils

This method sets the given beans property with the given name to the given value.

setPropertyValue(Object) - Method in class com.lexmark.saperion.PropertyType

Sets the property value.

setQueryAllowed(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setQueryAllowed(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setRead(Boolean) - Method in class com.lexmark.saperion.workflow.TaskListItemType

Sets whether this task was already read or not.

setReadOnly(boolean) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets whether this field is read-only or not.

setReceiveDate(Date) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task's receive date.

setRecipientList(List<ActorListItemType<? extends ActorReferenceType>>) - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This setter sets the list of users the recipient(s) can be chosen from.

setRecipientRequired(boolean) - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This setter sets whether a recipient is required for the workflow step.

setRecipientSelection(RecipientSelectionType) - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

Sets the recipients selection type of the workflow.

setRecipientSelection(RecipientSelectionType) - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

This setter sets if and in what way the next recipient is selected.

setReference(DocumentReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

setReference(LookupEntryReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

setReference(T) - Method in class com.lexmark.saperion.ListItemType

Sets the associated object's reference.

setReference(T) - Method in class com.lexmark.saperion.ResourceType

Sets the resource's object reference.

setRequired(boolean) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets whether this field is required or not.

setRestricted(Boolean) - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This setter sets whether the recipient selection is restricted to a list of actors or whether the recipient(s) can be chosen freely.

setRevisionReference(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

Sets the revision reference.

setRevisionReference(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.document.DocumentStoreInformationType

Sets the revision reference.

setRevisionReference(DocumentRevisionReferenceType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Set the reference to the document for which the workflow was started.

setRevisionTag(String) - Method in class com.lexmark.saperion.document.DocumentRevisionType

Sets the revision tag.

setRole(RoleReferenceType) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

This setter sets the role to assign to this group.

setRole(RoleReferenceType) - Method in class com.lexmark.saperion.administration.GroupType

This setter sets the role assigned to this group.

setSchemaExtension(GroupReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.administration.GroupManagementService

This method stores the given schema-extension for the given group.

setSchemaExtension(TenantReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.administration.TenantManagementService

This method stores the given schema-extension for the given tenant.

setSchemaExtension(UserReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.administration.UserManagementService

This method stores the given schema-extension for the given user.

setShortName(String) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the shortName.

setShortName(String) - Method in class com.lexmark.saperion.administration.GroupType

Sets the short-name of the group.

setShortName(String) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the shortName.

setShortName(String) - Method in class com.lexmark.saperion.administration.UserType

This setter sets the short name (display name).

setSingleActorSelection(Boolean) - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

This setter sets whether one and only one recipient has to be selected or a list of recipients.

setSsoUser(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setSsoUser(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setState(WorkflowProcessStateEnum) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow state.

setStorageSize(Long) - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

setStructure(DocumentElementType) - Method in class com.lexmark.saperion.document.CreateDocumentInputType

Sets the structure of the new document.

setSubject(String) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task subject.

setSubstituteAccessAllowed(Boolean) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets whether the user's substitute can access the inbox.

setSubstituteAccessAllowed(boolean) - Method in class com.lexmark.saperion.administration.UserType

Sets whether the user's substitute can access the inbox.

setSuperAdministrator(Boolean) - Method in class com.lexmark.saperion.administration.RolePropertiesType

setSuperAdministrator(boolean) - Method in class com.lexmark.saperion.administration.RoleType

setSynchronizedGroup(Boolean) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the synchronized property of this group.

setSynchronizedGroup(boolean) - Method in class com.lexmark.saperion.administration.GroupType

Sets the synchronized property of this group.

setSynchronizedUser(Boolean) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the synchronized user property.

setSynchronizedUser(boolean) - Method in class com.lexmark.saperion.administration.UserType

Sets the synchronized user property.

setSysRowId(String) - Method in class com.lexmark.saperion.document.DocumentReferenceType

Sets the SYSROWID.

setSysRowId(String) - Method in class com.lexmark.saperion.folder.FolderReferenceType

Sets the sysRowId.

setSysRowId(String) - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

This setter sets the id of the database row the lookup entry represents.

setSystemField(boolean) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets whether this field is a system-field or not.

setSystemFieldNames(List<String>) - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

setTaskReference(TaskReferenceType) - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

setTaskReference(TaskReferenceType) - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

setTechnicalUser(Boolean) - Method in class com.lexmark.saperion.administration.UserPropertiesType

Sets the technical user property.

setTechnicalUser(boolean) - Method in class com.lexmark.saperion.administration.UserType

Sets the technical user property.

setTenant(TenantReferenceType) - Method in class com.lexmark.saperion.administration.UserType

This setter sets the reference to the tenant the user is part of.

setTenantSpecific(boolean) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Sets the workflow tenant property.

setTextColor(int) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the text color.

setTextRotation(int) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the text rotation.

setTimeInformation(TimeInfoType) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task time information.

setTimeInformation(TimeInfoType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow process time information.

setTotalCount(Integer) - Method in class com.lexmark.saperion.workflow.InboxListItemType

Sets the number of items in this inbox.

setTransparent(boolean) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the transparent.

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.ActorListItemType

Sets the actor's type.

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.ActorReferenceType

Sets the actor type.

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.ActorType

Sets the actor type.

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.GroupReferenceType

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.GroupType

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.UserReferenceType

setType(ActorTypeEnum) - Method in class com.lexmark.saperion.administration.UserType

setType(String) - Method in class com.lexmark.saperion.exceptions.ErrorDetailsType

Sets the error details type.

setType(FieldTypeEnum) - Method in class com.lexmark.saperion.PropertyType

Sets the property type.

setType(InboxTypeEnumeration) - Method in class com.lexmark.saperion.workflow.InboxListItemType

Sets the type of the inbox.

setType(WorkflowProcessTypeEnum) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow process type.

setUncompressedSize(long) - Method in class com.lexmark.saperion.document.ContentMetaDataType

setUnicode(boolean) - Method in class com.lexmark.saperion.archive.StringFieldType

Sets whether this field contains unicode-strings or not.

setUnique(boolean) - Method in class com.lexmark.saperion.archive.FieldDefinition

Sets whether this field is unique or not.

setUnreadCount(Integer) - Method in class com.lexmark.saperion.workflow.InboxListItemType

Sets the number of all unread items in this inbox.

setURI(URI) - Method in class com.lexmark.saperion.document.InputStreamReferenceType

Sets the stream's id.

setUser(UserReferenceType) - Method in class com.lexmark.saperion.administration.UserAccessType

Sets the user reference.

setUser(UserReferenceType) - Method in class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

setUserAccessRights(List<UserAccessType>) - Method in class com.lexmark.saperion.administration.AclPropertiesType

setUserAccessRights(List<UserAccessType>) - Method in class com.lexmark.saperion.administration.AclType

setUserFields(Map<String, PropertyType>) - Method in class com.lexmark.saperion.workflow.TaskType

Sets the task's user fields.

setValue(Literal<?>) - Method in class com.lexmark.saperion.search.expression.BinaryOperation

setVariables(Map<String, String>) - Method in class com.lexmark.saperion.document.DocumentElementType

Sets the element variables.

setVersion(int) - Method in class com.lexmark.saperion.archive.ArchiveListItemType

Sets the version of this archive.

setVersion(int) - Method in class com.lexmark.saperion.archive.ArchiveType

Sets the version of this archive.

setVersion(String) - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

Sets the workflow definition version.

setViolatedFields(List<String>) - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

setWhere(Expression) - Method in class com.lexmark.saperion.search.query.Statement

Sets the expression representing the where clause of the query.

setWidth(short) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the width.

setWordWrap(boolean) - Method in class com.lexmark.saperion.document.TextAnnotationType

Sets the word wrap.

setWorkflowDefinition(WorkflowDefinitionListItemType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessListItemType

Sets the workflow definition that is associated with the given workflow process.

setWorkflowDefinition(WorkflowDefinitionType) - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

Sets the workflow process definition.

setWorkflowErrorCode(int) - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

setWorkflowPoolEnabled(Boolean) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the workflow-pool-enabled property of this group.

setWorkflowPoolEnabled(boolean) - Method in class com.lexmark.saperion.administration.GroupType

Sets the workflow-pool-enabled property of this group.

setWorkingTime(int) - Method in class com.lexmark.saperion.workflow.TimeInfoType

Sets the task working time.

setWorkInPoolAllowed(Boolean) - Method in class com.lexmark.saperion.administration.GroupPropertiesType

Sets the work-in-pool-allowed proeprty of this group.

setWorkInPoolAllowed(boolean) - Method in class com.lexmark.saperion.administration.GroupType

Sets the work-in-pool-allowed proeprty of this group.

setWriteAttempt(ReferenceType) - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

setX(short) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the x.

setY(short) - Method in class com.lexmark.saperion.document.AnnotationType

Sets the y.

SimpleExpressionContext - Class in com.lexmark.saperion.search.context

Implementation of an expression interpreter context.

SimpleExpressionContext() - Constructor for class com.lexmark.saperion.search.context.SimpleExpressionContext

startVisit(BooleanAndExpression) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

startVisit(BooleanOrExpression) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

startVisit(Statement) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

startWorkflow(DocumentReferenceType, String) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

startWorkflow(DocumentReferenceType, String, List<ActorReferenceType>) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

startWorkflow(DocumentReferenceType, String) - Method in interface com.lexmark.saperion.client.workflow.WorkflowDefinitionClient

This method starts a workflow for the given document.

startWorkflow(DocumentReferenceType, String, List<ActorReferenceType>) - Method in interface com.lexmark.saperion.client.workflow.WorkflowDefinitionClient

This method starts a workflow for the given document.

startWorkflowProcess(WorkflowDefinitionReferenceType, DocumentReferenceType, List<? extends ActorReferenceType>, String) - Method in interface com.lexmark.saperion.workflow.WorkflowDefinitionService

This method starts a workflow process given a workflow definition and a document (by its id).

Statement - Class in com.lexmark.saperion.search.query

The statement type represents a query to an object store.

Statement() - Constructor for class com.lexmark.saperion.search.query.Statement

statement(List<String>, Expression, List<FieldOrderDescriptor>) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new Statement with the given members.

StringFieldType - Class in com.lexmark.saperion.archive

This FieldType contains String-values.

StringFieldType() - Constructor for class com.lexmark.saperion.archive.StringFieldType

Creates a new StringFieldType.

StringLiteral - Class in com.lexmark.saperion.search.literal

The string literal implements the required functionality to represent string literals.

StringLiteral(String) - Constructor for class com.lexmark.saperion.search.literal.StringLiteral

Constructs a string literal with the given value.

StructureCompositeDocumentElementType - Class in com.lexmark.saperion.document

This document element representes a structure element that may have child documents i.e.

StructureCompositeDocumentElementType() - Constructor for class com.lexmark.saperion.document.StructureCompositeDocumentElementType

supports(ErrorCodeType) - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

supports(ErrorCodeType) - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionFactory

This method determines if an exception mapping for faults with the given error code exists in the factory instance.

SYSTEM_CONNECTION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SYSTEM_CONNECTION_POOL_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SYSTEM_DESERIALIZATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SYSTEM_GENERAL_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SYSTEM_SERIALIZATION_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

SystemError(int) - Constructor for class com.lexmark.saperion.exceptions.system.SystemException.SystemError

Default constructor.

SystemException - Exception in com.lexmark.saperion.exceptions.system

Base implementation of ECMS system exceptions.

SystemException() - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Convenience constructor.

SystemException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Factory constructor.

SystemException(String) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given exception message.

SystemException(String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error details, exception cause and exception message.

SystemException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given exception cause.

SystemException(SystemException.SystemError) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error code.

SystemException(SystemException.SystemError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

SystemException(SystemException.SystemError, ErrorDetailsType, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error code, error details, exception cause and exception message.

SystemException(SystemException.SystemError, String) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error code and exception message.

SystemException(SystemException.SystemError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.system.SystemException

Creates a new exception with the given error code and exception cause.

SystemException.SystemError - Class in com.lexmark.saperion.exceptions.system

System error definition.

SystemExceptionFactory - Class in com.lexmark.saperion.exceptions.mappings

System exceptions factory implementation.

SystemExceptionFactory() - Constructor for class com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory

SystemExceptionFactory.SystemErrors - Enum in com.lexmark.saperion.exceptions.mappings

System error defintions.

SystemFieldWriteDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details for SystemFieldWriteException.

SystemFieldWriteDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

SystemFieldWriteException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that the client tried to change a system field manually.

SystemFieldWriteException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.SystemFieldWriteException

This is the constructor used for serialization.

SystemFieldWriteException(ArchiveReferenceType, List<String>) - Constructor for exception com.lexmark.saperion.exceptions.runtime.SystemFieldWriteException

T

TaskCapabilitiesEnum - Enum in com.lexmark.saperion.workflow

The task capabilities enumeration defines the functions that can be called on a workflow task.

TaskCommentReferenceType - Class in com.lexmark.saperion.workflow

This ReferenceType identifies comments at workflow tasks.

TaskCommentReferenceType() - Constructor for class com.lexmark.saperion.workflow.TaskCommentReferenceType

Creates a new comment reference.

TaskCommentType - Class in com.lexmark.saperion.workflow

The task comment type represents a comment of a workflow process.

TaskCommentType() - Constructor for class com.lexmark.saperion.workflow.TaskCommentType

Creates a new comment with an empty comment reference.

TaskListItemType - Class in com.lexmark.saperion.workflow

A TaskListItemType holds the most important information about a task that is contained in a workflow-inbox.

TaskListItemType() - Constructor for class com.lexmark.saperion.workflow.TaskListItemType

Constructs a new TaskListItemType.

TaskListItemType(TaskReferenceType) - Constructor for class com.lexmark.saperion.workflow.TaskListItemType

Constructs a new TaskListItemType.

TaskPropertyType - Class in com.lexmark.saperion.workflow

The task properties define all property values that can be directly changed by an application.

TaskPropertyType() - Constructor for class com.lexmark.saperion.workflow.TaskPropertyType

TaskReferenceType - Class in com.lexmark.saperion.workflow

This ReferenceType identifies workflow tasks.

TaskReferenceType() - Constructor for class com.lexmark.saperion.workflow.TaskReferenceType

Creates a new task reference.

TaskStateEnum - Enum in com.lexmark.saperion.workflow

The task state enumeration defines the possible states that a task can have.

TaskType - Class in com.lexmark.saperion.workflow

The task type is a representation of a task in a running workflow process.

TaskType() - Constructor for class com.lexmark.saperion.workflow.TaskType

Creates a new task instance.

TENANT_CLAIM - Static variable in class com.lexmark.saperion.TokenConstants

Name of the claim that contains the tenant in a JWT.

TenantClient - Interface in com.lexmark.saperion.client.administration

This client provides functionality to administrate a given tenant.

TenantClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of TenantClient.

TenantClientImpl(TenantManagementService, TenantReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

TenantListItemType - Class in com.lexmark.saperion.administration

List item type for tenant entities.

TenantListItemType() - Constructor for class com.lexmark.saperion.administration.TenantListItemType

Default constructor.

TenantListItemType(TenantReferenceType) - Constructor for class com.lexmark.saperion.administration.TenantListItemType

Creates a tenant list item instance with the given tenant reference.

TenantManagementClient - Interface in com.lexmark.saperion.client.administration

This client provides functionality to administrate tenants in a saperion system.

TenantManagementClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of TenantManagementClient.

TenantManagementClientImpl(TenantManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

TenantManagementService - Interface in com.lexmark.saperion.administration

The tenant management service provides the required operations to create, read, update and delete tenant entities in the user management system.

tenantReferenceFromId(int) - Static method in class com.lexmark.saperion.TypeConversions

This factory method create a new tenant reference given a tenant id.

TenantReferenceType - Class in com.lexmark.saperion.administration

This ReferenceType identifies tenants in a saperion user management.

TenantReferenceType() - Constructor for class com.lexmark.saperion.administration.TenantReferenceType

This is the default constructor.

TenantType - Class in com.lexmark.saperion.administration

This bean represents tenants in a saperion user administration.

TenantType() - Constructor for class com.lexmark.saperion.administration.TenantType

This is the default constructor.

terminate(WorkflowProcessReferenceType) - Method in interface com.lexmark.saperion.workflow.WorkflowProcessService

This method terminates the workflow process given.

TextAnnotationType - Class in com.lexmark.saperion.document

This annotation holds formatted text - a note.

TextAnnotationType() - Constructor for class com.lexmark.saperion.document.TextAnnotationType

TimeFieldType - Class in com.lexmark.saperion.archive

This FieldType contains time values.

TimeFieldType() - Constructor for class com.lexmark.saperion.archive.TimeFieldType

Creates a new TimeFieldType.

TimeInfoType - Class in com.lexmark.saperion.workflow

Specifies task related time information.

TimeInfoType() - Constructor for class com.lexmark.saperion.workflow.TimeInfoType

TokenConstants - Class in com.lexmark.saperion

This class contains common constants needed to share information in tokens.

TokenExpiredException - Exception in com.lexmark.saperion.exceptions.system

This exception is thrown when a user tries to invoke an operation when the user's token has already expired.

TokenExpiredException() - Constructor for exception com.lexmark.saperion.exceptions.system.TokenExpiredException

Creates a new TokenExpiredException.

TokenUserIdentification - Enum in com.lexmark.saperion

This enumeration contains the possible ways to identify a user in a token.

toString() - Method in class com.lexmark.saperion.administration.AclReferenceType

toString() - Method in class com.lexmark.saperion.administration.AclType

toString() - Method in class com.lexmark.saperion.administration.ActorListItemType

toString() - Method in class com.lexmark.saperion.administration.ActorReferenceType

toString() - Method in class com.lexmark.saperion.administration.ActorType

toString() - Method in class com.lexmark.saperion.administration.GroupAccessType

toString() - Method in class com.lexmark.saperion.administration.GroupPropertiesType

toString() - Method in class com.lexmark.saperion.administration.GroupReferenceType

toString() - Method in class com.lexmark.saperion.administration.GroupType

toString() - Method in class com.lexmark.saperion.administration.RoleReferenceType

toString() - Method in class com.lexmark.saperion.administration.RoleType

toString() - Method in class com.lexmark.saperion.administration.TenantReferenceType

toString() - Method in class com.lexmark.saperion.administration.TenantType

toString() - Method in class com.lexmark.saperion.administration.UserAccessType

toString() - Method in class com.lexmark.saperion.administration.UserPropertiesType

toString() - Method in class com.lexmark.saperion.administration.UserReferenceType

toString() - Method in class com.lexmark.saperion.administration.UserType

toString() - Method in class com.lexmark.saperion.archive.ArchiveListItemType

toString() - Method in class com.lexmark.saperion.archive.ArchiveReferenceType

toString() - Method in class com.lexmark.saperion.archive.ArchiveType

toString() - Method in class com.lexmark.saperion.archive.CurrencyFieldType

toString() - Method in class com.lexmark.saperion.archive.EnumFieldType

toString() - Method in class com.lexmark.saperion.archive.FieldDefinition

toString() - Method in class com.lexmark.saperion.archive.FieldType

toString() - Method in class com.lexmark.saperion.archive.FloatFieldType

toString() - Method in class com.lexmark.saperion.archive.ListFieldType

toString() - Method in class com.lexmark.saperion.archive.LookupFieldType

toString() - Method in class com.lexmark.saperion.archive.StringFieldType

toString() - Method in class com.lexmark.saperion.document.AnnotationAccessDataType

toString() - Method in class com.lexmark.saperion.document.AnnotationType

toString() - Method in class com.lexmark.saperion.document.ArrowAnnotationType

toString() - Method in class com.lexmark.saperion.document.ContentDocumentElementType

toString() - Method in class com.lexmark.saperion.document.ContentMetaDataType

toString() - Method in class com.lexmark.saperion.document.CreateDocumentInputType

toString() - Method in class com.lexmark.saperion.document.DocumentContentMetaDataType

toString() - Method in class com.lexmark.saperion.document.DocumentElementReferenceType

toString() - Method in class com.lexmark.saperion.document.DocumentElementStoreInformationType

toString() - Method in class com.lexmark.saperion.document.DocumentElementType

toString() - Method in class com.lexmark.saperion.document.DocumentReferenceType

toString() - Method in class com.lexmark.saperion.document.DocumentRevisionListItemType

toString() - Method in class com.lexmark.saperion.document.DocumentRevisionReferenceType

toString() - Method in class com.lexmark.saperion.document.DocumentRevisionType

toString() - Method in class com.lexmark.saperion.document.FileDocumentElementType

toString() - Method in class com.lexmark.saperion.document.HashDescriptor

toString() - Method in class com.lexmark.saperion.document.InputStreamReferenceType

toString() - Method in class com.lexmark.saperion.document.LinkDocumentElementType

toString() - Method in class com.lexmark.saperion.document.StructureCompositeDocumentElementType

toString() - Method in class com.lexmark.saperion.document.UpdateDocumentInputType

toString() - Method in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

toString() - Method in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

toString() - Method in class com.lexmark.saperion.exceptions.ErrorCodeType

toString() - Method in class com.lexmark.saperion.exceptions.ErrorDetailsType

toString() - Method in class com.lexmark.saperion.exceptions.ErrorType

toString() - Method in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

toString() - Method in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

toString() - Method in class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

toString() - Method in class com.lexmark.saperion.folder.CreateFolderInputType

toString() - Method in class com.lexmark.saperion.folder.UpdateFolderInputType

toString() - Method in class com.lexmark.saperion.ListItemType

toString() - Method in class com.lexmark.saperion.lookup.LookupEntryListItemType

toString() - Method in class com.lexmark.saperion.lookup.LookupEntryReferenceType

toString() - Method in class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

toString() - Method in class com.lexmark.saperion.ModificationMetaDataType

toString() - Method in class com.lexmark.saperion.PropertyType

toString() - Method in class com.lexmark.saperion.ReferenceType

toString() - Method in class com.lexmark.saperion.ResourceType

toString() - Method in class com.lexmark.saperion.search.expression.BinaryOperation

toString() - Method in class com.lexmark.saperion.search.expression.BooleanAndExpression

toString() - Method in class com.lexmark.saperion.search.expression.BooleanNotExpression

toString() - Method in class com.lexmark.saperion.search.expression.BooleanOrExpression

toString() - Method in class com.lexmark.saperion.search.expression.UnaryOperation

toString() - Method in class com.lexmark.saperion.search.literal.Literal

toString() - Method in class com.lexmark.saperion.search.query.FieldOrderDescriptor

toString() - Method in class com.lexmark.saperion.search.query.Statement

toString() - Method in class com.lexmark.saperion.workflow.InboxListItemType

toString() - Method in class com.lexmark.saperion.workflow.InboxReferenceType

toString() - Method in class com.lexmark.saperion.workflow.RecipientSelectionType

toString() - Method in class com.lexmark.saperion.workflow.TaskCommentReferenceType

toString() - Method in class com.lexmark.saperion.workflow.TaskCommentType

toString() - Method in class com.lexmark.saperion.workflow.TaskListItemType

toString() - Method in class com.lexmark.saperion.workflow.TaskPropertyType

toString() - Method in class com.lexmark.saperion.workflow.TaskReferenceType

toString() - Method in class com.lexmark.saperion.workflow.TaskType

toString() - Method in class com.lexmark.saperion.workflow.TimeInfoType

toString() - Method in class com.lexmark.saperion.workflow.TransitionDefinitionType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionListItemType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowDefinitionType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowProcessListItemType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

toString() - Method in class com.lexmark.saperion.workflow.WorkflowProcessType

TransitionDefinitionType - Class in com.lexmark.saperion.workflow

A transition definition represents the different exit path of a workflow node.

TransitionDefinitionType() - Constructor for class com.lexmark.saperion.workflow.TransitionDefinitionType

TYPE - Static variable in class com.lexmark.saperion.exceptions.application.GenericWorkflowErrorDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.ConcurrentWriteDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.DocumentLockedDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.LookupEntryLockedDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.MandatoryConstraintViolationDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.SystemFieldWriteDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

TYPE - Static variable in class com.lexmark.saperion.exceptions.system.PasswordExpiredDetails

TypeConversions - Class in com.lexmark.saperion

This utility class holds static conversion methods for the types defined in this project.

TypeConverter - Class in com.lexmark.saperion.adapter

The type converter is a utility class that supports conversions from type adapters to bean types.

U

UnaryOperation - Class in com.lexmark.saperion.search.expression

This expression represents an unary operation on a field.

UnaryOperation() - Constructor for class com.lexmark.saperion.search.expression.UnaryOperation

UnaryOperation(String, UnaryOperation.Operator) - Constructor for class com.lexmark.saperion.search.expression.UnaryOperation

UnaryOperation.Operator - Enum in com.lexmark.saperion.search.expression

undelete() - Method in interface com.lexmark.saperion.client.administration.AclClient

This method un-deletes the access control list.

undelete() - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method un-deletes the group.

undelete() - Method in interface com.lexmark.saperion.client.administration.RoleClient

This method un-deletes the role.

undelete() - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method un-deletes the tenant.

undelete() - Method in interface com.lexmark.saperion.client.administration.UserClient

This method un-deletes the user.

undelete() - Method in class com.lexmark.saperion.client.implementation.administration.AclClientImpl

undelete() - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

undelete() - Method in class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

undelete() - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

undelete() - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

undeleteAcl(AclReferenceType) - Method in interface com.lexmark.saperion.administration.AclManagementService

Un-deletes the access control list with the given reference.

undeleteGroup(GroupReferenceType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

Un-deletes the group with the given reference.

undeleteRole(RoleReferenceType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

Un-deletes the role with the given reference.

undeleteTenant(TenantReferenceType) - Method in interface com.lexmark.saperion.administration.TenantManagementService

Un-deletes the tenant with the given reference.

undeleteUser(UserReferenceType) - Method in interface com.lexmark.saperion.administration.UserManagementService

Un-deletes the referenced user.

UniqueConstraintViolationDetails - Class in com.lexmark.saperion.exceptions.runtime

These are the details for MandatoryConstraintViolationException.

UniqueConstraintViolationDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationDetails

UniqueConstraintViolationException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that an create or update operation violated a unique constraint.

UniqueConstraintViolationException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationException

This is the constructor used for serialization.

UniqueConstraintViolationException(ArchiveReferenceType, Map<String, PropertyType>, List<String>) - Constructor for exception com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationException

UniqueConstraintViolationException(String, ArchiveReferenceType, Map<String, PropertyType>, List<String>) - Constructor for exception com.lexmark.saperion.exceptions.runtime.UniqueConstraintViolationException

uniqueResult(Expression) - Method in class com.lexmark.saperion.client.implementation.SearchClientImpl

uniqueResult(Expression) - Method in interface com.lexmark.saperion.client.SearchClient

This convenience method expects the filter to return at most one result.

unlock() - Method in interface com.lexmark.saperion.client.document.DocumentClient

This method unlocks the document.

unlock() - Method in class com.lexmark.saperion.client.implementation.document.DocumentClientImpl

unlockDocument(DocumentReferenceType) - Method in interface com.lexmark.saperion.document.DocumentService

This method unlocks a document.

unrestrictedUserSelection(boolean) - Static method in class com.lexmark.saperion.TypeConversions

This factory method creates a new RecipientSelectionType indicating that user selection is required and not restricted.

update(AclPropertiesType) - Method in interface com.lexmark.saperion.client.administration.AclClient

This method updates the access control list with the given properties.

update(GroupPropertiesType) - Method in interface com.lexmark.saperion.client.administration.GroupClient

This method updates the group with the given properties.

update(RolePropertiesType) - Method in interface com.lexmark.saperion.client.administration.RoleClient

This method updates the role with the given properties.

update(String) - Method in interface com.lexmark.saperion.client.administration.TenantClient

This method updates the tenant with the given properties.

update(UserPropertiesType) - Method in interface com.lexmark.saperion.client.administration.UserClient

This method updates the referenced user with the given properties.

update(DocumentElementType) - Method in interface com.lexmark.saperion.client.document.DocumentElementClient

This method updates the document element instance and replaces it with the given entity.

update(Map<String, PropertyType>, DocumentElementType) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method updates the document instance and replaces the document with the given entity.

update(DocumentElementType) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This is a shorthand for update(Collections.<String, PropertyType> emptyMap(), documentElement) updating only the document element and leaving the index data untouched.

update(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This is a shorthand for update(indexData, null) updating only the index data and leaving the document structure untouched.

update(UpdateDocumentInputType) - Method in interface com.lexmark.saperion.client.document.DocumentRevisionClient

This method updates the document with the given properties containing index-data, structure-data and ACLs.

update(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method updates the properties of the given folder.

update(UpdateFolderInputType) - Method in interface com.lexmark.saperion.client.folder.FolderClient

This method updates the properties of the given folder.

update(AclPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.AclClientImpl

update(GroupPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.GroupClientImpl

update(RolePropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.RoleClientImpl

update(String) - Method in class com.lexmark.saperion.client.implementation.administration.TenantClientImpl

update(UserPropertiesType) - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

update(DocumentElementType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentElementClientImpl

update(Map<String, PropertyType>, DocumentElementType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

update(DocumentElementType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

update(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

update(UpdateDocumentInputType) - Method in class com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

update(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

update(UpdateFolderInputType) - Method in class com.lexmark.saperion.client.implementation.folder.FolderClientImpl

update(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

update(UpdateLookupEntryInputType) - Method in class com.lexmark.saperion.client.implementation.lookup.LookupEntryClientImpl

update(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method updates a Lookup entry instance.

update(UpdateLookupEntryInputType) - Method in interface com.lexmark.saperion.client.lookup.LookupEntryClient

This method updates a Lookup entry instance.

updateAcl(AclReferenceType, AclPropertiesType) - Method in interface com.lexmark.saperion.administration.AclManagementService

Updates the referenced access control list with the given properties.

updateDocument(DocumentRevisionReferenceType, Map<String, PropertyType>, DocumentElementType) - Method in interface com.lexmark.saperion.document.DocumentService

This method updates a document given by its revision reference with the given data.

updateDocument(DocumentRevisionReferenceType, UpdateDocumentInputType) - Method in interface com.lexmark.saperion.document.DocumentService

This method updates a document given by its revision reference with the given data.

updateDocumentElement(DocumentRevisionReferenceType, DocumentElementReferenceType, DocumentElementType) - Method in interface com.lexmark.saperion.document.DocumentService

This method replaces the document element given by its reference and a reference to the latest revision of the element it resides in.

UpdateDocumentInputType - Class in com.lexmark.saperion.document

Document properties type.

UpdateDocumentInputType() - Constructor for class com.lexmark.saperion.document.UpdateDocumentInputType

updateFolder(FolderReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.folder.FolderService

This method updates a folder with the given index data.

updateFolder(FolderReferenceType, UpdateFolderInputType) - Method in interface com.lexmark.saperion.folder.FolderService

This method updates a folder with the given properties.

UpdateFolderInputType - Class in com.lexmark.saperion.folder

Protocol binding type for folder update operations.

UpdateFolderInputType() - Constructor for class com.lexmark.saperion.folder.UpdateFolderInputType

updateGroup(GroupReferenceType, GroupPropertiesType) - Method in interface com.lexmark.saperion.administration.GroupManagementService

Updates a group with the given properties.

updateIndexData(Map<String, PropertyType>) - Method in class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

updateIndexData(Map<String, PropertyType>) - Method in interface com.lexmark.saperion.client.workflow.WorkflowTaskClient

This method updates the task's index data.

updateIndexData(TaskReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.workflow.WorkflowTaskService

Updates the task's index data.

updateLookupEntry(LookupEntryReferenceType, UpdateLookupEntryInputType) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

Updates the lookup entry given by the id in the given ddc with the given properties.

updateLookupEntry(LookupEntryReferenceType, Map<String, PropertyType>) - Method in interface com.lexmark.saperion.lookup.LookupEntryService

Updates the lookup entry given by the id in the given ddc with the given properties.

UpdateLookupEntryInputType - Class in com.lexmark.saperion.lookup

Data binding for lookup-entry update operation.

UpdateLookupEntryInputType() - Constructor for class com.lexmark.saperion.lookup.UpdateLookupEntryInputType

updatePassword(String) - Method in interface com.lexmark.saperion.client.administration.UserClient

This method updates the password of the user.

updatePassword(String) - Method in class com.lexmark.saperion.client.implementation.administration.UserClientImpl

updateRole(RoleReferenceType, RolePropertiesType) - Method in interface com.lexmark.saperion.administration.RoleManagementService

Updates the referenced role with the given properties.

updateTenant(TenantReferenceType, String) - Method in interface com.lexmark.saperion.administration.TenantManagementService

Updates the referenced tenant with the given properties.

updateUser(UserReferenceType, UserPropertiesType) - Method in interface com.lexmark.saperion.administration.UserManagementService

Updates the referenced user with the given properties.

updateUserPassword(UserReferenceType, String) - Method in interface com.lexmark.saperion.administration.UserManagementService

Updates the referenced user with the given properties.

USER_CLAIM - Static variable in class com.lexmark.saperion.TokenConstants

Name of the claim that contains the user-name in a JWT.

USER_IDENTIFICATION_CLAIM - Static variable in class com.lexmark.saperion.TokenConstants

Name of the claim that contains the way a user is identified.

UserAccessType - Class in com.lexmark.saperion.administration

Representation of the access rights granted amd denied to a user.

UserAccessType() - Constructor for class com.lexmark.saperion.administration.UserAccessType

Default constructor: Creates a new unititalized UserAccessType instance.

UserAccessType(UserReferenceType, Set<AccessRight>, Set<AccessRight>) - Constructor for class com.lexmark.saperion.administration.UserAccessType

Creates a UserAccessType instance with the given user and access rights.

UserAccessType(UserReferenceType, Set<AccessRight>) - Constructor for class com.lexmark.saperion.administration.UserAccessType

Creates a UserAccessType instance with the given user and access rights.

UserAccessType(UserReferenceType) - Constructor for class com.lexmark.saperion.administration.UserAccessType

Creates a UserAccessType instance with no access rights.

UserAdministrationClient - Interface in com.lexmark.saperion.client.administration

This saperion client provides a client-interface with methods for getting user-administration-clients.

UserAdministrationClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default-implementation of UserAdministrationClient.

UserAdministrationClientImpl(TenantManagementService, GroupManagementService, UserManagementService, RoleManagementService, AclManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.UserAdministrationClientImpl

UserClient - Interface in com.lexmark.saperion.client.administration

This client provides functionality to administrate a given user.

UserClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of UserClient.

UserClientImpl(UserManagementService, UserReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.administration.UserClientImpl

UserListItemType - Class in com.lexmark.saperion.administration

List item type for user entities.

UserListItemType() - Constructor for class com.lexmark.saperion.administration.UserListItemType

Default constructor.

UserListItemType(UserReferenceType) - Constructor for class com.lexmark.saperion.administration.UserListItemType

Creates a user list item instance with the given user reference.

userListItemType(int, String) - Static method in class com.lexmark.saperion.TypeConversions

UserManagementService - Interface in com.lexmark.saperion.administration

The user management service provides the required operations to create, read, update and delete user entities in the user management system.

UserManagementServiceClient - Interface in com.lexmark.saperion.client.administration

This client provides functionality to administrate the users of a saperion system.

UserManagementServiceClientImpl - Class in com.lexmark.saperion.client.implementation.administration

This is the default implementation of UserManagementService.

UserManagementServiceClientImpl(UserManagementService) - Constructor for class com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

UserPropertiesType - Class in com.lexmark.saperion.administration

Data transfer object for user properties that can be user to update an existing user.

UserPropertiesType() - Constructor for class com.lexmark.saperion.administration.UserPropertiesType

userReferenceFromId(int) - Static method in class com.lexmark.saperion.TypeConversions

This factory method create a new user reference given a user id.

UserReferenceType - Class in com.lexmark.saperion.administration

The user reference type.

UserReferenceType() - Constructor for class com.lexmark.saperion.administration.UserReferenceType

UserType - Class in com.lexmark.saperion.administration

The user type represents a user in the system.

UserType() - Constructor for class com.lexmark.saperion.administration.UserType

Constructs a new user type instance.

V

validate() - Method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

validate(ErrorCodeType) - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionFactory

Checks that the error code is supported by exactly one registered exception factory.

validate() - Method in class com.lexmark.saperion.exceptions.mappings.EcmsExceptionMapping

validate() - Method in interface com.lexmark.saperion.exceptions.mappings.ExceptionMapping

Validates the integrity of the exception mapping.

validate() - Method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

validate() - Method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

valueOf(String) - Static method in enum com.lexmark.saperion.administration.AccessRight

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.administration.ActorTypeEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.archive.ArchiveContentEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.archive.ArchiveFeatureEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.archive.ArchiveIsolationEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.archive.FieldTypeEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.client.SaperionConnectionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.document.DocumentNodeType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.document.LoadKindEnumeration

Returns the enum constant of this type with the specified name.

valueOf(ErrorCodeType) - Method in class com.lexmark.saperion.exceptions.mappings.AbstractExceptionFactory

Returns the exception mapping for this error code.

valueOf(String) - Static method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.LicenseEnumeration

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.search.expression.BinaryOperation.Operator

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.search.expression.UnaryOperation.Operator

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.search.query.FieldOrderDescriptor.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.TokenUserIdentification

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.InboxTypeEnumeration

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.TaskCapabilitiesEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.TaskStateEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.WorkflowProcessStateEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.WorkflowProcessTypeEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.lexmark.saperion.workflow.WorkflowTypeEnum

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.lexmark.saperion.administration.AccessRight

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.administration.ActorTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.archive.ArchiveContentEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.archive.ArchiveFeatureEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.archive.ArchiveIsolationEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.archive.FieldTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.client.SaperionConnectionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.document.DocumentNodeType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.document.LoadKindEnumeration

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in class com.lexmark.saperion.exceptions.EcmErrorCodes

Returns all error code constant definitions from this class.

values() - Static method in enum com.lexmark.saperion.exceptions.mappings.ApplicationExceptionFactory.ApplicationErrors

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.LicenseEnumeration

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.search.expression.BinaryOperation.Operator

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.search.expression.UnaryOperation.Operator

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.search.query.FieldOrderDescriptor.Order

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.TokenUserIdentification

Returns an array containing the constants of this enum type, in the order they are declared.

values(Class<?>, Class<T>) - Static method in class com.lexmark.saperion.util.ConstantUtils

Inspects a constant definition class and returns all constant definitions of the given element type.

values() - Static method in enum com.lexmark.saperion.workflow.InboxTypeEnumeration

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.workflow.TaskCapabilitiesEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.workflow.TaskStateEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.workflow.WorkflowProcessStateEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.workflow.WorkflowProcessTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.lexmark.saperion.workflow.WorkflowTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

visit(BooleanAndExpression) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

visit(BooleanOrExpression) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

visit(Statement) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

visit(BooleanNotExpression) - Method in class com.lexmark.saperion.search.context.AbstractExpressionVisitor

visit(BooleanAndExpression) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when a boolean 'and' is encountered.

visit(BooleanOrExpression) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when a boolean 'or' is encountered.

visit(Statement) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when a statement is encountered.

visit(BinaryOperation) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when a binary operation is encountered.

visit(BooleanNotExpression) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when a boolean 'not' is encountered.

visit(UnaryOperation) - Method in interface com.lexmark.saperion.search.context.ExpressionVisitor

This callback is called when an unary operation is encountered.

W

WORKFLOW_ACTOR_REQUIRED - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

WORKFLOW_ERROR - Static variable in class com.lexmark.saperion.exceptions.EcmErrorCodes

WorkflowActorRequiredDetails - Class in com.lexmark.saperion.exceptions.application

Details for the WorkflowActorRequiredException.

WorkflowActorRequiredDetails() - Constructor for class com.lexmark.saperion.exceptions.application.WorkflowActorRequiredDetails

WorkflowActorRequiredException - Exception in com.lexmark.saperion.exceptions.application

Indicates that an actor selection is required in a workflow forward operation.

WorkflowActorRequiredException() - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(String, Throwable, WorkflowActorRequiredDetails) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(String, WorkflowActorRequiredDetails) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(String, List<ActorListItemType<? extends ActorReferenceType>>, RecipientSelectionType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowActorRequiredException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowActorRequiredException

WorkflowDefinitionClient - Interface in com.lexmark.saperion.client.workflow

This client provides functionality concerning workflow definitions.

WorkflowDefinitionClientImpl - Class in com.lexmark.saperion.client.implementation.workflow

This is the default implementation of WorkflowDefinitionClient.

WorkflowDefinitionClientImpl(WorkflowDefinitionService, WorkflowDefinitionReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.workflow.WorkflowDefinitionClientImpl

WorkflowDefinitionListItemType - Class in com.lexmark.saperion.workflow

This list item type holds easy to access data of a workflow definition stored in the system.

WorkflowDefinitionListItemType() - Constructor for class com.lexmark.saperion.workflow.WorkflowDefinitionListItemType

Creates a new list item type with an empty reference.

WorkflowDefinitionListItemType(WorkflowDefinitionReferenceType) - Constructor for class com.lexmark.saperion.workflow.WorkflowDefinitionListItemType

Creates a new list item type with the given reference.

WorkflowDefinitionReferenceType - Class in com.lexmark.saperion.workflow

This ReferenceType identifies workflow definitions.

WorkflowDefinitionReferenceType() - Constructor for class com.lexmark.saperion.workflow.WorkflowDefinitionReferenceType

Creates a new workflow definition reference.

WorkflowDefinitionService - Interface in com.lexmark.saperion.workflow

This service provides functionality concerning workflow definitions.

WorkflowDefinitionType - Class in com.lexmark.saperion.workflow

The workflow definition type represents a workflow definition stored in the system.

WorkflowDefinitionType() - Constructor for class com.lexmark.saperion.workflow.WorkflowDefinitionType

Creates a new workflow definition type.

WorkflowError(int) - Constructor for class com.lexmark.saperion.exceptions.application.WorkflowException.WorkflowError

Creates a new error with the given error value.

WorkflowException - Exception in com.lexmark.saperion.exceptions.application

Security base exception.

WorkflowException() - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Default constuctor.

WorkflowException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Exception factory constructor.

WorkflowException(String) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given exception message.

WorkflowException(String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error details, exception cause and exception message.

WorkflowException(String, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error details and exception message.

WorkflowException(Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given exception cause.

WorkflowException(WorkflowException.WorkflowError) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code.

WorkflowException(WorkflowException.WorkflowError, ErrorDetailsType, Map<String, String>, String, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

WorkflowException(WorkflowException.WorkflowError, String, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code, error details, exception cause and exception message.

WorkflowException(WorkflowException.WorkflowError, String) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code and exception message.

WorkflowException(WorkflowException.WorkflowError, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code and exception cause.

WorkflowException(WorkflowException.WorkflowError, String, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code and exception message.

WorkflowException(WorkflowException.WorkflowError, Throwable, ErrorDetailsType) - Constructor for exception com.lexmark.saperion.exceptions.application.WorkflowException

Creates a new exception with the given error code and exception cause.

WorkflowException.WorkflowError - Class in com.lexmark.saperion.exceptions.application

Error code implementation for application exceptions.

WorkflowInboxClient - Interface in com.lexmark.saperion.client.workflow

This client provides functionality for a given workflow inbox.

WorkflowInboxClientImpl - Class in com.lexmark.saperion.client.implementation.workflow

This is the default implementation of WorkflowInboxClient.

WorkflowInboxClientImpl(WorkflowInboxService, InboxListItemType) - Constructor for class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxClientImpl

WorkflowInboxService - Interface in com.lexmark.saperion.workflow

This service provides functionality concerning workflow inboxes.

WorkflowInboxServiceClient - Interface in com.lexmark.saperion.client.workflow

This client serves as an entry point for searches in and for workflow in boxes.

WorkflowInboxServiceClientImpl - Class in com.lexmark.saperion.client.implementation.workflow

This is the default implementation of WorkflowInboxServiceClient.

WorkflowInboxServiceClientImpl(WorkflowInboxService) - Constructor for class com.lexmark.saperion.client.implementation.workflow.WorkflowInboxServiceClientImpl

WorkflowProcessListItemType - Class in com.lexmark.saperion.workflow

This list item type holds easy to access data of a workflow process instance.

WorkflowProcessListItemType() - Constructor for class com.lexmark.saperion.workflow.WorkflowProcessListItemType

Creates an empty workflow process list item.

WorkflowProcessListItemType(WorkflowProcessReferenceType) - Constructor for class com.lexmark.saperion.workflow.WorkflowProcessListItemType

Creates a workflow process list item for the given process reference.

WorkflowProcessReferenceType - Class in com.lexmark.saperion.workflow

This ReferenceType identifies instances of workflow processes.

WorkflowProcessReferenceType() - Constructor for class com.lexmark.saperion.workflow.WorkflowProcessReferenceType

Creates a new workflow process reference.

WorkflowProcessService - Interface in com.lexmark.saperion.workflow

This service provides functionality concerning running workflow process instances.

WorkflowProcessStateEnum - Enum in com.lexmark.saperion.workflow

The process state enumeration lists all possible states of a workflow process.

WorkflowProcessType - Class in com.lexmark.saperion.workflow

A workflow process is a workflow that was started for a particular document.

WorkflowProcessType() - Constructor for class com.lexmark.saperion.workflow.WorkflowProcessType

Creates a new workflow process type.

WorkflowProcessTypeEnum - Enum in com.lexmark.saperion.workflow

Defines the possible workflow types.

WorkflowServiceClient - Interface in com.lexmark.saperion.client.workflow

This client provides functionality and services concerning workflow.

WorkflowServiceClientImpl - Class in com.lexmark.saperion.client.implementation.workflow

This is the default implementation of WorkflowServiceClient.

WorkflowServiceClientImpl(WorkflowDefinitionService, WorkflowInboxService, WorkflowProcessService, WorkflowTaskService) - Constructor for class com.lexmark.saperion.client.implementation.workflow.WorkflowServiceClientImpl

WorkflowTaskClient - Interface in com.lexmark.saperion.client.workflow

This client provides functionality for a given workflow task.

WorkflowTaskClientImpl - Class in com.lexmark.saperion.client.implementation.workflow

This is the default implementation of WorkflowTaskClient.

WorkflowTaskClientImpl(WorkflowTaskService, TaskReferenceType) - Constructor for class com.lexmark.saperion.client.implementation.workflow.WorkflowTaskClientImpl

WorkflowTaskService - Interface in com.lexmark.saperion.workflow

This service provides functionality concerning workflow tasks.

WorkflowTypeEnum - Enum in com.lexmark.saperion.workflow

The enumeration defines the workflow types supported in the system.

WrongArchiveKindDetails - Class in com.lexmark.saperion.exceptions.runtime

This class holds the exception details of WrongArchiveKindException.

WrongArchiveKindDetails() - Constructor for class com.lexmark.saperion.exceptions.runtime.WrongArchiveKindDetails

WrongArchiveKindException - Exception in com.lexmark.saperion.exceptions.runtime

This exception indicates that a request to an archive was made that the archive type does not support.

WrongArchiveKindException(ErrorType, Throwable) - Constructor for exception com.lexmark.saperion.exceptions.runtime.WrongArchiveKindException

This is the constructor used for serialization.

WrongArchiveKindException(String, ArchiveReferenceType, ArchiveContentEnum, ArchiveContentEnum) - Constructor for exception com.lexmark.saperion.exceptions.runtime.WrongArchiveKindException

This constructor creates a new exception for the case that the given archive reference was expected to reference an archive of the given expected archive type but was instead referencing an archive of the given encountered archive type.

X

XmlFieldType - Class in com.lexmark.saperion.archive

This FieldType contains XML values.

XmlFieldType() - Constructor for class com.lexmark.saperion.archive.XmlFieldType

Creates a new XmlFieldType.

A B C D E F G H I L M N O P R S T U V W X