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

Class VoAttributesModuleAbstract

java.lang.Object

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

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

All Implemented Interfaces:

AttributesModuleImplApi, VoAttributesModuleImplApi

Direct Known Subclasses:

urn_perun_vo_attribute_def_def_applicationAffiliationRegex, 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_notificationsDefLang, urn_perun_vo_attribute_def_def_RTVoQueue, urn_perun_vo_attribute_def_def_toEmail

public abstract class VoAttributesModuleAbstract
extends AttributesModuleAbstract
implements VoAttributesModuleImplApi

Abstract class for Vo Attributes modules. ----------------------------------------------------------------------------- Implements methods for modules to perform default function. In the function that the method in the module does nothing, it is not necessary to implement it, simply extend this abstract class.

Author:

Michal Stava <stavamichal@gmail.com>

Constructor Summary

Constructors

Constructor	Description
VoAttributesModuleAbstract()

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 session, Vo vo, AttributeDefinition attribute)	This method tries to fill appropriate Virtual Organization (Vo) attributes.

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleAbstract

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Methods inherited from class java.lang.Object

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

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

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Constructor Details

VoAttributesModuleAbstract

public VoAttributesModuleAbstract()

Method Details

changedAttributeHook

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

Description copied from interface: VoAttributesModuleImplApi

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

Specified by:

changedAttributeHook in interface VoAttributesModuleImplApi

Parameters:

session - session

vo - the vo

attribute - the attribute

checkAttributeSemantics

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

Description copied from interface: VoAttributesModuleImplApi

Checks if value of this vo attribute has valid semantics.

Specified by:

checkAttributeSemantics in interface VoAttributesModuleImplApi

Parameters:

perunSession - Perun session

vo - Virtual Organization

attribute - attribute to be checked

Throws:

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

checkAttributeSyntax

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

Description copied from interface: VoAttributesModuleImplApi

Checks if value of this vo attribute has valid syntax.

Specified by:

checkAttributeSyntax in interface VoAttributesModuleImplApi

Parameters:

perunSession - Perun session

vo - Virtual Organization

attribute - attribute to be checked

Throws:

WrongAttributeValueException - if the attribute value has wrong/illegal syntax

fillAttribute

public Attribute fillAttribute(PerunSessionImpl session,
 Vo vo,
 AttributeDefinition attribute)

Description copied from interface: VoAttributesModuleImplApi

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

Specified by:

fillAttribute in interface VoAttributesModuleImplApi

Parameters:

session - Perun session

vo - Virtual Organization

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

Returns:

attribute which MAY by filled in.