odrlmodel.Rule Class Reference

Inheritance diagram for odrlmodel.Rule:

Public Member Functions
	Rule ()
	Rule (String _uri)
int	getKindOfRule ()
void	setKindOfRule (int _ikind)
List< Action >	getActions ()
void	setActions (List< Action > _actions)
List< Constraint >	getConstraints ()
void	setConstraints (List< Constraint > _constraints)
void	addAction (Action a)
void	addConstraint (Constraint a)
void	setAssignee (Party _assignee)
Party	getAssignee ()
void	setAssigner (Party _assigner)
Party	getAssigner ()
String	toString ()
void	setTarget (String target1)
Public Member Functions inherited from odrlmodel.MetadataObject
	MetadataObject ()
	MetadataObject (String _uri)
	MetadataObject (MetadataObject mo)
void	setURI (String _uri)
String	getURI ()
boolean	isAnon ()
String	getComment ()
void	setComment (String _comment)
String	getSeeAlso ()
String	getTitle ()
void	setTitle (String _title)
String	getLabel (String lan)
void	addLabel (String label)
void	setLabel (String label, String lang)
void	setLabel (String _label)
String	toString ()

Public Attributes
List< Action >	actions = new ArrayList()
List< Constraint >	constraints = new ArrayList()
String	target =""
Public Attributes inherited from odrlmodel.MetadataObject
List< String >	labels = new ArrayList()
String	comment = ""
String	seeAlso =""
String	title =""
String	uri = ""

Static Public Attributes
static final int	RULE_PERMISSION = 0
static final int	RULE_PROHIBITION = 1
static final int	RULE_DUTY = 2
Static Public Attributes inherited from odrlmodel.MetadataObject
static final String	DEFAULT_NAMESPACE = LDRConfig.getNamespace()

Protected Member Functions
String	getKindOfRuleString ()

Protected Attributes
Party	assignee =null
Party	assigner = null

Detailed Description

This class represents a simple ODRL rule Rule is an abstract common ancestor to Permissions, Prohibitions and Duties. A Rule (reduced version of the ODRL Rule) is made of:

• Zero or more actions
• Zero or more constraints
• Zero or one assignee (party enjoying the permission/prohibition/duty)
• Zero or one target (object over which the rule applies)
• Zero or one assigner (party assigning the rule)

  Author

  Victor Rodriguez Doncel at OEG-UPM 2014

Constructor & Destructor Documentation

odrlmodel.Rule.Rule

(

)

Rule constructor with a random URI in the default namespace A rule is by default a constructor

odrlmodel.Rule.Rule

(

String

_uri

)

Rule constructor with a given URI

Parameters

_uri	A valid URI. Can be an empty string (anonymous source)

Member Function Documentation

List<Action> odrlmodel.Rule.getActions

(

)

Gets the actions associated to this rule

Party odrlmodel.Rule.getAssignee

(

)

Gets the assignee of the rule.

Returns

The assignee

Party odrlmodel.Rule.getAssigner

(

)

Gets the assigner of the rule.

Returns

The assigner

List<Constraint> odrlmodel.Rule.getConstraints

(

)

Gets the list of constraints the rule has.

Returns

List of constraints

int odrlmodel.Rule.getKindOfRule

(

)

Gets the kind of the rule

Returns

either Rule.RULE_PERMISSION, Rule.RULE_PROHIBITION or Rule.RULE_DUTY

String odrlmodel.Rule.getKindOfRuleString ( )

protected

Gets an string describing the kind of the rule

Returns

either "Permission", or "Prohibition" or "Duty" -empty if unkown kind.

void odrlmodel.Rule.setActions

(

List< Action >

_actions

)

Sets the actions referred by this rule

Parameters

_actions

List of actions

void odrlmodel.Rule.setAssignee

(

Party

_assignee

)

Sets the assignee of the rule

Parameters

_assignee

void odrlmodel.Rule.setAssigner

(

Party

_assigner

)

Sets the assigner of the rule

Parameters

_assigner

void odrlmodel.Rule.setConstraints

(

List< Constraint >

_constraints

)

Sets the constraints for this rule to apply

Parameters

_constraints

List of constratins

void odrlmodel.Rule.setKindOfRule

(

int

_ikind

)

Sets the kind of rule

Parameters

_ikind

either Rule.RULE_PERMISSION, Rule.RULE_PROHIBITION or Rule.RULE_DUTY

---

The documentation for this class was generated from the following file:

• src/odrlmodel/Rule.java