Package de.xima.fc.handler.entity

Class FormRecordAccessHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.FormRecordAccessHandler

All Implemented Interfaces:

IAPIHandler, IFormRecordAccessHandler, IGenericHandler, Serializable

public class FormRecordAccessHandler
extends GenericHandler
implements IFormRecordAccessHandler

See Also:

Serialized Form

Field Summary

Fields inherited from class de.xima.fc.handler.entity.GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
FormRecordAccessHandler()

Method Summary

Modifier and Type	Method	Description
FormRecordAccess	getByExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef)	Retrieves a FormRecordAccess entity by its associated Vorgang and IExternalUserRef.
List<FormRecordAccess>	getByFormRecord(UserContext uc, Vorgang formRecord)	Retrieves a list of FormRecordAccess entities associated with a given Vorgang.
FormRecordAccess	getByMail(UserContext uc, Vorgang formRecord, String mail)	Retrieves a FormRecordAccess entity by its associated Vorgang and email address.
FormRecordAccess	getByUserRef(UserContext uc, Vorgang formRecord, IUserRef userRef)	Retrieves a FormRecordAccess entity by its associated Vorgang and IUserRef.
FormRecordAccess	getOrCreateByMail(UserContext uc, Vorgang formRecord, String mail, EFormRecordAccessGrantType grantType)	Creates or retrieves a FormRecordAccess entity by its associated Vorgang and email address.
FormRecordAccess	getOrCreateExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef, EFormRecordAccessGrantType grantType)	Creates or retrieves a FormRecordAccess entity by its associated Vorgang and external user reference.
FormRecordAccess	getOrCreateUserRef(UserContext uc, Vorgang formRecord, IUserRef userRef, EFormRecordAccessGrantType grantType)	Creates or retrieves a FormRecordAccess entity by its associated Vorgang and user reference.

Methods inherited from class de.xima.fc.handler.entity.GenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update

Methods inherited from class de.xima.fc.handler.AMSApiHandler

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Constructor Detail

FormRecordAccessHandler

public FormRecordAccessHandler()

Method Detail

getByUserRef

public FormRecordAccess getByUserRef(UserContext uc,
                                     Vorgang formRecord,
                                     IUserRef userRef)

Description copied from interface: IFormRecordAccessHandler

Retrieves a FormRecordAccess entity by its associated Vorgang and IUserRef.

Specified by:

getByUserRef in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

userRef - The IUserRef to search for.

Returns:

The found FormRecordAccess entity, or null if not found.

getByExternalUserRef

public FormRecordAccess getByExternalUserRef(UserContext uc,
                                             Vorgang formRecord,
                                             IExternalUserRef externalUserRef)

Description copied from interface: IFormRecordAccessHandler

Retrieves a FormRecordAccess entity by its associated Vorgang and IExternalUserRef.

Specified by:

getByExternalUserRef in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

externalUserRef - The IExternalUserRef to search for.

Returns:

The found FormRecordAccess entity, or null if not found.

getByMail

public FormRecordAccess getByMail(UserContext uc,
                                  Vorgang formRecord,
                                  String mail)

Description copied from interface: IFormRecordAccessHandler

Retrieves a FormRecordAccess entity by its associated Vorgang and email address.

Specified by:

getByMail in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

mail - The email address to search for.

Returns:

The found FormRecordAccess entity, or null if not found.

getByFormRecord

public List<FormRecordAccess> getByFormRecord(UserContext uc,
                                              Vorgang formRecord)

Description copied from interface: IFormRecordAccessHandler

Retrieves a list of FormRecordAccess entities associated with a given Vorgang.

Specified by:

getByFormRecord in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

Returns:

A list of FormRecordAccess entities.

getOrCreateByMail

public FormRecordAccess getOrCreateByMail(UserContext uc,
                                          Vorgang formRecord,
                                          String mail,
                                          EFormRecordAccessGrantType grantType)

Description copied from interface: IFormRecordAccessHandler

Creates or retrieves a FormRecordAccess entity by its associated Vorgang and email address.

Specified by:

getOrCreateByMail in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

mail - The email address to search for.

grantType - The access grant type.

Returns:

The created or retrieved FormRecordAccess entity.

getOrCreateExternalUserRef

public FormRecordAccess getOrCreateExternalUserRef(UserContext uc,
                                                   Vorgang formRecord,
                                                   IExternalUserRef externalUserRef,
                                                   EFormRecordAccessGrantType grantType)

Description copied from interface: IFormRecordAccessHandler

Creates or retrieves a FormRecordAccess entity by its associated Vorgang and external user reference.

Specified by:

getOrCreateExternalUserRef in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

externalUserRef - The external user ref to search for.

grantType - The access grant type.

Returns:

The created or retrieved FormRecordAccess entity.

getOrCreateUserRef

public FormRecordAccess getOrCreateUserRef(UserContext uc,
                                           Vorgang formRecord,
                                           IUserRef userRef,
                                           EFormRecordAccessGrantType grantType)

Description copied from interface: IFormRecordAccessHandler

Creates or retrieves a FormRecordAccess entity by its associated Vorgang and user reference.

Specified by:

getOrCreateUserRef in interface IFormRecordAccessHandler

Parameters:

uc - The user context.

formRecord - The associated Vorgang.

userRef - The user ref to search for.

grantType - The access grant type.

Returns:

The created or retrieved FormRecordAccess entity.