Package de.fraunhofer.iese.mydata.affiliation

Interface IAffiliationService

All Known Subinterfaces:

IManagementService

public interface IAffiliationService

The Interface IAffiliationService.

Method Summary

Modifier and Type	Method	Description
AffiliationId	addAffiliation(Affiliation affiliation)	Adds the affiliation.
boolean	affiliationIdExists(AffiliationId affiliationId)	Checks if this affiliationId exists
void	deleteAffiliation(AffiliationId affiliationId)	Delete affiliation.
Affiliation	getAffiliation(AffiliationId affiliationId)	Gets the affiliation.
Affiliation	getAffiliationBySolutionId(SolutionId solutionId)	Returns the affiliation a solutionid (solution) belongs to
Affiliation	getAffiliationByUserUUID(String userUUID)	Returns the affiliations for a specific user It can be a set as a super_admin is per default assigned to all affiliations
AffiliationId	getAffiliationIdBySolutionId(SolutionId solutionId)	Returns the affiliationId a solutionid (solution) belongs to
AffiliationId	getAffiliationIdByUserUUID(String userUUID)	Returns the affiliationids for a specific user It can be a set as a super_admin is per default assigned to all affiliations
Set<Affiliation>	getAffiliations(boolean includeLocked)	Gets the affiliations.
Set<AffiliationId>	listAffiliations(boolean includeLocked)	Gets the affiliation ids.
void	lockAffiliation(AffiliationId affiliationId)	Lock affiliation.
void	unlockAffiliation(AffiliationId affiliationId)	Unlock affiliation.
void	updateAffiliation(Affiliation affiliation)	Update affiliation.

Method Detail

addAffiliation

AffiliationId addAffiliation(Affiliation affiliation)
                      throws IOException,
                             ConflictingResourceException,
                             ResourceUpdateException,
                             InvalidEntityException

Adds the affiliation.

Parameters:

affiliation - the solution

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

ConflictingResourceException

ResourceUpdateException

InvalidEntityException

affiliationIdExists

boolean affiliationIdExists(AffiliationId affiliationId)
                     throws IOException,
                            InvalidEntityException

Checks if this affiliationId exists

Parameters:

affiliationId -

Returns:

true if this id is already in the DB, false if not

Throws:

IOException

InvalidEntityException

updateAffiliation

void updateAffiliation(Affiliation affiliation)
                throws IOException,
                       ResourceUpdateException,
                       NoSuchEntityException,
                       InvalidEntityException

Update affiliation.

Parameters:

affiliation - the solution

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException

NoSuchEntityException

InvalidEntityException

getAffiliation

Affiliation getAffiliation(AffiliationId affiliationId)
                    throws IOException,
                           InvalidEntityException,
                           NoSuchEntityException

Gets the affiliation.

Parameters:

affiliationId - the affiliation component_id

Returns:

the affiliation

Throws:

IOException - Signals that an I/O exception has occurred.

InvalidEntityException

NoSuchEntityException

listAffiliations

Set<AffiliationId> listAffiliations(boolean includeLocked)
                             throws IOException

Gets the affiliation ids.

Parameters:

includeLocked - : if true, also includes locked affiliations

Returns:

the affiliation ids

Throws:

IOException - Signals that an I/O exception has occurred.

getAffiliations

Set<Affiliation> getAffiliations(boolean includeLocked)
                          throws IOException

Gets the affiliations.

Parameters:

includeLocked - : if true, also includes locked affiliations

Returns:

the affiliations

Throws:

IOException - Signals that an I/O exception has occurred.

lockAffiliation

void lockAffiliation(AffiliationId affiliationId)
              throws IOException,
                     ResourceUpdateException,
                     NoSuchEntityException,
                     InvalidEntityException

Lock affiliation.

Parameters:

affiliationId -

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException

NoSuchEntityException

InvalidEntityException

unlockAffiliation

void unlockAffiliation(AffiliationId affiliationId)
                throws IOException,
                       ResourceUpdateException,
                       NoSuchEntityException,
                       InvalidEntityException

Unlock affiliation.

Parameters:

affiliationId -

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException

NoSuchEntityException

InvalidEntityException

deleteAffiliation

void deleteAffiliation(AffiliationId affiliationId)
                throws IOException,
                       ResourceUpdateException,
                       NoSuchEntityException,
                       InvalidEntityException

Delete affiliation.

Parameters:

affiliationId -

Throws:

IOException - Signals that an I/O exception has occurred.

ResourceUpdateException

NoSuchEntityException

InvalidEntityException

getAffiliationByUserUUID

Affiliation getAffiliationByUserUUID(String userUUID)
                              throws IOException,
                                     NoSuchEntityException

Returns the affiliations for a specific user It can be a set as a super_admin is per default assigned to all affiliations

Parameters:

userUUID -

Returns:

a list(set) of affiliations

Throws:

IOException

NoSuchEntityException

getAffiliationIdByUserUUID

AffiliationId getAffiliationIdByUserUUID(String userUUID)
                                  throws IOException,
                                         NoSuchEntityException

Returns the affiliationids for a specific user It can be a set as a super_admin is per default assigned to all affiliations

Parameters:

userUUID -

Returns:

a list(set) of affiliationids

Throws:

IOException

NoSuchEntityException

getAffiliationIdBySolutionId

AffiliationId getAffiliationIdBySolutionId(SolutionId solutionId)
                                    throws IOException,
                                           InvalidEntityException,
                                           NoSuchEntityException

Returns the affiliationId a solutionid (solution) belongs to

Parameters:

solutionId -

Returns:

an affiliationid

Throws:

IOException

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist

getAffiliationBySolutionId

Affiliation getAffiliationBySolutionId(SolutionId solutionId)
                                throws IOException,
                                       InvalidEntityException,
                                       NoSuchEntityException

Returns the affiliation a solutionid (solution) belongs to

Parameters:

solutionId -

Returns:

an affiliation

Throws:

IOException

InvalidEntityException - if the solution id is not valid

NoSuchEntityException - if the solution does not exist