org.eclipse.gmf.mappings
Interface AuditRule

All Superinterfaces:

EObject, Notifier, RuleBase

All Known Implementing Classes:

AuditRuleImpl

public interface AuditRule

extends RuleBase

A representation of the model object 'Audit Rule'.

The following features are supported:

• Id
• Rule
• Target
• Severity
• Use In Live Mode
• Message
• Container

See Also:

GMFMapPackage.getAuditRule()

** Generated **

Model:

Method Summary

AuditContainer	getContainer() Returns the value of the 'Container' container reference.
java.lang.String	getId() Returns the value of the 'Id' attribute
java.lang.String	getMessage() Returns the value of the 'Message' attribute
Constraint	getRule() Returns the value of the 'Rule' containment reference
Severity	getSeverity() Returns the value of the 'Severity' attribute.
Auditable	getTarget() Returns the value of the 'Target' containment reference
boolean	isUseInLiveMode() Returns the value of the 'Use In Live Mode' attribute.
void	setContainer(AuditContainer value) Sets the value of the 'Container' container reference
void	setId(java.lang.String value) Sets the value of the 'Id' attribute
void	setMessage(java.lang.String value) Sets the value of the 'Message' attribute
void	setRule(Constraint value) Sets the value of the 'Rule' containment reference
void	setSeverity(Severity value) Sets the value of the 'Severity' attribute
void	setTarget(Auditable value) Sets the value of the 'Target' containment reference
void	setUseInLiveMode(boolean value) Sets the value of the 'Use In Live Mode' attribute

Methods inherited from interface org.eclipse.gmf.mappings.RuleBase

getDescription, getName, setDescription, setName

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getId

public java.lang.String getId()

Returns the value of the 'Id' attribute. Unique identifier of this audit rule

Returns:

the value of the 'Id' attribute.

See Also:

AuditRule.setId(String), GMFMapPackage.getAuditRule_Id()

** Generated **

Model:

required="true" annotation="http://www.eclipse.org/gmf/2005/constraints ocl='not id.oclIsUndefined() implies container.audits->one(i | i.id = self.id)' description='Audit rule with the same ID already exists'"

setId

public void setId(java.lang.String value)

Sets the value of the 'Id' attribute.

Parameters:

value - the new value of the 'Id' attribute.

See Also:

AuditRule.getId()

** Generated **

getRule

public Constraint getRule()

Returns the value of the 'Rule' containment reference. A boolean type condition which if not satisfied indicates this audit rule violation. It is evaluated in the context of the target

Returns:

the value of the 'Rule' containment reference.

See Also:

AuditRule.setRule(Constraint), GMFMapPackage.getAuditRule_Rule()

** Generated **

Model:

containment="true" required="true" annotation="http://www.eclipse.org/gmf/2005/constraints/meta def='context' ref='target'"

setRule

public void setRule(Constraint value)

Sets the value of the 'Rule' containment reference.

Parameters:

value - the new value of the 'Rule' containment reference.

See Also:

AuditRule.getRule()

** Generated **

getTarget

public Auditable getTarget()

Returns the value of the 'Target' containment reference. The target representing the context this audit is evaluated in

Returns:

the value of the 'Target' containment reference.

See Also:

AuditRule.setTarget(Auditable), GMFMapPackage.getAuditRule_Target()

** Generated **

Model:

containment="true" required="true"

setTarget

public void setTarget(Auditable value)

Sets the value of the 'Target' containment reference.

Parameters:

value - the new value of the 'Target' containment reference.

See Also:

AuditRule.getTarget()

** Generated **

getSeverity

public Severity getSeverity()

Returns the value of the 'Severity' attribute. The default value is "ERROR". The literals are from the enumeration Severity. Describes the severity of this audit rule violation

Returns:

the value of the 'Severity' attribute.

See Also:

Severity, AuditRule.setSeverity(Severity), GMFMapPackage.getAuditRule_Severity()

** Generated **

Model:

default="ERROR"

setSeverity

public void setSeverity(Severity value)

Sets the value of the 'Severity' attribute.

Parameters:

value - the new value of the 'Severity' attribute.

See Also:

Severity, AuditRule.getSeverity()

** Generated **

isUseInLiveMode

public boolean isUseInLiveMode()

Returns the value of the 'Use In Live Mode' attribute. The default value is "false". Indicates if this audit should be evaluated also in Live mode. If 'false', only Batch mode is applicable

Returns:

the value of the 'Use In Live Mode' attribute.

See Also:

AuditRule.setUseInLiveMode(boolean), GMFMapPackage.getAuditRule_UseInLiveMode()

** Generated **

Model:

default="false"

setUseInLiveMode

public void setUseInLiveMode(boolean value)

Sets the value of the 'Use In Live Mode' attribute.

Parameters:

value - the new value of the 'Use In Live Mode' attribute.

See Also:

AuditRule.isUseInLiveMode()

** Generated **

getMessage

public java.lang.String getMessage()

Returns the value of the 'Message' attribute. The text message to be reported in case of this audit violation

Returns:

the value of the 'Message' attribute.

See Also:

AuditRule.setMessage(String), GMFMapPackage.getAuditRule_Message()

** Generated **

Model:

setMessage

public void setMessage(java.lang.String value)

Sets the value of the 'Message' attribute.

Parameters:

value - the new value of the 'Message' attribute.

See Also:

AuditRule.getMessage()

** Generated **

getContainer

public AuditContainer getContainer()

Returns the value of the 'Container' container reference. It is bidirectional and its opposite is 'Audits'. The containing audit container of this audit rule

Returns:

the value of the 'Container' container reference.

See Also:

AuditRule.setContainer(AuditContainer), GMFMapPackage.getAuditRule_Container(), AuditContainer.getAudits()

** Generated **

Model:

opposite="audits" required="true"

setContainer

public void setContainer(AuditContainer value)

Sets the value of the 'Container' container reference.

Parameters:

value - the new value of the 'Container' container reference.

See Also:

AuditRule.getContainer()

** Generated **