Package cz.metacentrum.perun.core.implApi.modules.attributes

Interface VoAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Implementing Classes:

urn_perun_vo_attribute_def_def_applicationAffiliationRegex, urn_perun_vo_attribute_def_def_applicationAutoRejectMessages, urn_perun_vo_attribute_def_def_applicationExpirationRules, urn_perun_vo_attribute_def_def_applicationViewPreferences, urn_perun_vo_attribute_def_def_aup, urn_perun_vo_attribute_def_def_autoApproveByGroupMembership, urn_perun_vo_attribute_def_def_contactEmail, urn_perun_vo_attribute_def_def_fromEmail, urn_perun_vo_attribute_def_def_htmlMailFooter, urn_perun_vo_attribute_def_def_membershipExpirationRules, urn_perun_vo_attribute_def_def_notificationsDefLang, urn_perun_vo_attribute_def_def_RTVoQueue, urn_perun_vo_attribute_def_def_toEmail, VoAttributesModuleAbstract

public interface VoAttributesModuleImplApi
extends AttributesModuleImplApi

This interface serves as a template for checking and filling in Virtual Organization (Vo) attributes.

Author:

Lukáš Pravda <luky.pravda@gmail.com>

Method Summary

Modifier and Type	Method	Description
void	changedAttributeHook(PerunSessionImpl session, Vo vo, Attribute attribute)	If you need to do some further work with other modules, this method do that
void	checkAttributeSemantics(PerunSessionImpl perunSession, Vo vo, Attribute attribute)	Checks if value of this vo attribute has valid semantics.
void	checkAttributeSyntax(PerunSessionImpl perunSession, Vo vo, Attribute attribute)	Checks if value of this vo attribute has valid syntax.
Attribute	fillAttribute(PerunSessionImpl perunSession, Vo vo, AttributeDefinition attribute)	This method tries to fill appropriate Virtual Organization (Vo) attributes.

Methods inherited from interface cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleImplApi

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Method Details

changedAttributeHook

void changedAttributeHook(PerunSessionImpl session,
 Vo vo,
 Attribute attribute)

If you need to do some further work with other modules, this method do that

Parameters:

session - session

vo - the vo

attribute - the attribute

checkAttributeSemantics

void checkAttributeSemantics(PerunSessionImpl perunSession,
 Vo vo,
 Attribute attribute)
                      throws WrongReferenceAttributeValueException,
WrongAttributeAssignmentException

Checks if value of this vo attribute has valid semantics.

Parameters:

perunSession - Perun session

vo - Virtual Organization

attribute - attribute to be checked

Throws:

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

WrongAttributeAssignmentException

checkAttributeSyntax

void checkAttributeSyntax(PerunSessionImpl perunSession,
 Vo vo,
 Attribute attribute)
                   throws WrongAttributeValueException

Checks if value of this vo attribute has valid syntax.

Parameters:

perunSession - Perun session

vo - Virtual Organization

attribute - attribute to be checked

Throws:

InternalErrorException - if an exception is raised in particular implementation, the exception is wrapped in InternalErrorException

WrongAttributeValueException - if the attribute value has wrong/illegal syntax

fillAttribute

Attribute fillAttribute(PerunSessionImpl perunSession,
 Vo vo,
 AttributeDefinition attribute)

This method tries to fill appropriate Virtual Organization (Vo) attributes.

Parameters:

perunSession - Perun session

vo - Virtual Organization

attribute - Attribute of which you'd like to check.

Returns:

attribute which MAY by filled in.