org.eclipse.gmf.codegen.gmfgen
Interface GenAuditRule

All Superinterfaces:

EObject, GenRuleBase, Notifier

All Known Implementing Classes:

GenAuditRuleImpl

public interface GenAuditRule

extends GenRuleBase

A representation of the model object 'Gen Audit Rule'. Auditing rule in the form of a constraint evaluated against its target

The following features are supported:

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

See Also:

GMFGenPackage.getGenAuditRule()

** Generated **

Model:

Method Summary

java.lang.String	getConstraintAdapterClassName()
java.lang.String	getConstraintAdapterLocalClassName()
java.lang.String	getConstraintAdapterQualifiedClassName()
GenAuditContainer	getContainer() Returns the value of the 'Container' container reference.
java.lang.String	getContextSelectorClassName()
java.lang.String	getContextSelectorLocalClassName()
java.lang.String	getContextSelectorQualifiedClassName()
java.lang.String	getId() Returns the value of the 'Id' attribute
java.lang.String	getMessage() Returns the value of the 'Message' attribute
GenConstraint	getRule() Returns the value of the 'Rule' containment reference
GenSeverity	getSeverity() Returns the value of the 'Severity' attribute.
GenAuditable	getTarget() Returns the value of the 'Target' containment reference
boolean	isUseInLiveMode() Returns the value of the 'Use In Live Mode' attribute.
boolean	requiresConstraintAdapter()
void	setContainer(GenAuditContainer 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(GenConstraint value) Sets the value of the 'Rule' containment reference
void	setSeverity(GenSeverity value) Sets the value of the 'Severity' attribute
void	setTarget(GenAuditable 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.codegen.gmfgen.GenRuleBase

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.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Unique identifier of this audit rule

Returns:

the value of the 'Id' attribute.

See Also:

GenAuditRule.setId(String), GMFGenPackage.getGenAuditRule_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:

GenAuditRule.getId()

** 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:

GenAuditRule.setMessage(String), GMFGenPackage.getGenAuditRule_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:

GenAuditRule.getMessage()

** Generated **

getRule

public GenConstraint getRule()

Returns the value of the 'Rule' containment reference.

If the meaning of the 'Rule' reference isn't clear, there really should be more of a description here...

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:

GenAuditRule.setRule(GenConstraint), GMFGenPackage.getGenAuditRule_Rule()

** Generated **

Model:

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

setRule

public void setRule(GenConstraint value)

Sets the value of the 'Rule' containment reference.

Parameters:

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

See Also:

GenAuditRule.getRule()

** Generated **

getTarget

public GenAuditable 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:

GenAuditRule.setTarget(GenAuditable), GMFGenPackage.getGenAuditRule_Target()

** Generated **

Model:

containment="true" required="true"

setTarget

public void setTarget(GenAuditable value)

Sets the value of the 'Target' containment reference.

Parameters:

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

See Also:

GenAuditRule.getTarget()

** Generated **

getSeverity

public GenSeverity getSeverity()

Returns the value of the 'Severity' attribute. The default value is "ERROR". The literals are from the enumeration GenSeverity.

If the meaning of the 'Severity' attribute isn't clear, there really should be more of a description here...

Describes the severity of this audit rule violation

Returns:

the value of the 'Severity' attribute.

See Also:

GenSeverity, GenAuditRule.setSeverity(GenSeverity), GMFGenPackage.getGenAuditRule_Severity()

** Generated **

Model:

default="ERROR"

setSeverity

public void setSeverity(GenSeverity value)

Sets the value of the 'Severity' attribute.

Parameters:

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

See Also:

GenSeverity, GenAuditRule.getSeverity()

** Generated **

isUseInLiveMode

public boolean isUseInLiveMode()

Returns the value of the 'Use In Live Mode' attribute. The default value is "false".

If the meaning of the 'Use In Live Mode' attribute isn't clear, there really should be more of a description here...

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:

GenAuditRule.setUseInLiveMode(boolean), GMFGenPackage.getGenAuditRule_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:

GenAuditRule.isUseInLiveMode()

** Generated **

getContainer

public GenAuditContainer getContainer()

Returns the value of the 'Container' container reference. It is bidirectional and its opposite is 'Audits'.

If the meaning of the 'Container' containment reference isn't clear, there really should be more of a description here...

The containing audit container of this audit rule

Returns:

the value of the 'Container' container reference.

See Also:

GenAuditRule.setContainer(GenAuditContainer), GMFGenPackage.getGenAuditRule_Container(), GenAuditContainer.getAudits()

** Generated **

Model:

opposite="audits" required="true"

setContainer

public void setContainer(GenAuditContainer value)

Sets the value of the 'Container' container reference.

Parameters:

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

See Also:

GenAuditRule.getContainer()

** Generated **

getContextSelectorClassName

public java.lang.String getContextSelectorClassName()

** Generated **

Model:

kind="operation" required="true"

getContextSelectorQualifiedClassName

public java.lang.String getContextSelectorQualifiedClassName()

** Generated **

Model:

kind="operation" required="true"

getContextSelectorLocalClassName

public java.lang.String getContextSelectorLocalClassName()

** Generated **

Model:

kind="operation" required="true"

getConstraintAdapterLocalClassName

public java.lang.String getConstraintAdapterLocalClassName()

getConstraintAdapterClassName

public java.lang.String getConstraintAdapterClassName()

getConstraintAdapterQualifiedClassName

public java.lang.String getConstraintAdapterQualifiedClassName()

requiresConstraintAdapter

public boolean requiresConstraintAdapter()