Interface IFormRecordAccessHandler
- All Superinterfaces:
IAPIHandler, IGenericHandler, Serializable
- All Known Implementing Classes:
FormRecordAccessHandler
Handler for
FormRecordSubmission entities- Since:
- 8.2.0
- Author:
- XIMA Media GmbH
-
Method Summary
Modifier and TypeMethodDescriptiongetByExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef) getByFormRecord(UserContext uc, Vorgang formRecord) Retrieves a list ofFormRecordAccessentities associated with a givenVorgang.getByMail(UserContext uc, Vorgang formRecord, String mail) Retrieves aFormRecordAccessentity by its associatedVorgangand email address.getByUserRef(UserContext uc, Vorgang formRecord, IUserRef userRef) getOrCreateByMail(UserContext uc, Vorgang formRecord, String mail, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand email address.getOrCreateExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand external user reference.getOrCreateUserRef(UserContext uc, Vorgang formRecord, IUserRef userRef, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand user reference.Methods inherited from interface IAPIHandler
getNameMethods inherited from interface IGenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update
-
Method Details
-
getByUserRef
- Parameters:
uc- The user context.formRecord- The associatedVorgang.userRef- TheIUserRefto search for.- Returns:
- The found
FormRecordAccessentity, or null if not found.
-
getByExternalUserRef
FormRecordAccess getByExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef) - Parameters:
uc- The user context.formRecord- The associatedVorgang.externalUserRef- TheIExternalUserRefto search for.- Returns:
- The found
FormRecordAccessentity, or null if not found.
-
getByMail
Retrieves aFormRecordAccessentity by its associatedVorgangand email address.- Parameters:
uc- The user context.formRecord- The associatedVorgang.mail- The email address to search for.- Returns:
- The found
FormRecordAccessentity, or null if not found.
-
getByFormRecord
Retrieves a list ofFormRecordAccessentities associated with a givenVorgang.- Parameters:
uc- The user context.formRecord- The associatedVorgang.- Returns:
- A list of
FormRecordAccessentities.
-
getOrCreateByMail
FormRecordAccess getOrCreateByMail(UserContext uc, Vorgang formRecord, String mail, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand email address.- Parameters:
uc- The user context.formRecord- The associatedVorgang.mail- The email address to search for.grantType- The access grant type.- Returns:
- The created or retrieved
FormRecordAccessentity.
-
getOrCreateExternalUserRef
FormRecordAccess getOrCreateExternalUserRef(UserContext uc, Vorgang formRecord, IExternalUserRef externalUserRef, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand external user reference.- Parameters:
uc- The user context.formRecord- The associatedVorgang.externalUserRef- The external user ref to search for.grantType- The access grant type.- Returns:
- The created or retrieved
FormRecordAccessentity.
-
getOrCreateUserRef
FormRecordAccess getOrCreateUserRef(UserContext uc, Vorgang formRecord, IUserRef userRef, EFormRecordAccessGrantType grantType) Creates or retrieves aFormRecordAccessentity by its associatedVorgangand user reference.- Parameters:
uc- The user context.formRecord- The associatedVorgang.userRef- The user ref to search for.grantType- The access grant type.- Returns:
- The created or retrieved
FormRecordAccessentity.
-