Package de.xima.fc.api.entity

Class FormRecordAccessAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<FormRecordAccess>

de.xima.fc.api.entity.FormRecordAccessAPI

public class FormRecordAccessAPI
extends AEntityAPI<FormRecordAccess>

API class for reading and writing FormRecordAccess entities.

Since:

8.4.0

Author:

XIMA Media GmbH

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
FormRecordAccessAPI()

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.api.entity.AEntityAPI

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

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

FormRecordAccessAPI

public FormRecordAccessAPI()

Method Detail

getByUserRef

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

Retrieves a FormRecordAccess entity by its associated Vorgang and IUserRef.

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)

Retrieves a FormRecordAccess entity by its associated Vorgang and IExternalUserRef.

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)

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

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)

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

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)

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

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)

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

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)

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

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.