org.openl.rules.repository.api

Interface ArtefactAPI

All Known Subinterfaces:

FolderAPI, ResourceAPI

public interface ArtefactAPI

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, ValueType type, Object value)
void	clearModifyStatus()
void	commit(CommonUser user, int revision)
UserTransaction	createTransaction()
void	delete(CommonUser user)
ArtefactPath	getArtefactPath()
Map<String,InheritedProperty>	getInheritedProps()
LockInfo	getLockInfo()
String	getName()
Collection<Property>	getProperties() Gets list of all properties in the container.
Property	getProperty(String name) Returns property by name.
Map<String,Object>	getProps()
ProjectVersion	getVersion()
ArtefactAPI	getVersion(CommonVersion version)
ProjectVersion	getVersion(int index)
List<ProjectVersion>	getVersions()
int	getVersionsCount()
boolean	hasProperty(String name) Checks whether property with specified name exists in the container.
boolean	isFolder()
boolean	isModified()
void	lock(CommonUser user)
void	removeAllProperties()
Property	removeProperty(String name) Removes property from the container.
void	setProps(Map<String,Object> props)
void	unlock(CommonUser user)

Method Detail

isModified

boolean isModified()

addProperty

void addProperty(String name,
                 ValueType type,
                 Object value)
          throws PropertyException

Throws:

PropertyException

getProperties

Collection<Property> getProperties()

Gets list of all properties in the container.

Returns:

list of properties

getProperty

Property getProperty(String name)
              throws PropertyException

Returns property by name.

Parameters:

name - name of property

Returns:

reference on named property

Throws:

PropertyException - if no property with specified name

hasProperty

boolean hasProperty(String name)

Checks whether property with specified name exists in the container.

Parameters:

name - name of property

Returns:

true if such property exists

removeProperty

Property removeProperty(String name)
                 throws PropertyException

Removes property from the container.

Parameters:

name - name of property

Returns:

removed property

Throws:

PropertyException - if no property with specified name

removeAllProperties

void removeAllProperties()
                  throws PropertyException

Throws:

PropertyException

delete

void delete(CommonUser user)
     throws ProjectException

Throws:

ProjectException

getArtefactPath

ArtefactPath getArtefactPath()

getName

String getName()

isFolder

boolean isFolder()

getVersion

ProjectVersion getVersion()

getVersions

List<ProjectVersion> getVersions()

getVersionsCount

int getVersionsCount()

getVersion

ProjectVersion getVersion(int index)
                   throws RRepositoryException

Throws:

RRepositoryException

getLockInfo

LockInfo getLockInfo()

commit

void commit(CommonUser user,
            int revision)
     throws ProjectException

Throws:

ProjectException

lock

void lock(CommonUser user)
   throws ProjectException

Throws:

ProjectException

unlock

void unlock(CommonUser user)
     throws ProjectException

Throws:

ProjectException

getVersion

ArtefactAPI getVersion(CommonVersion version)
                throws ProjectException

Throws:

ProjectException

getProps

Map<String,Object> getProps()

setProps

void setProps(Map<String,Object> props)
       throws PropertyException

Throws:

PropertyException

createTransaction

UserTransaction createTransaction()
                           throws RRepositoryException

Throws:

RRepositoryException

getInheritedProps

Map<String,InheritedProperty> getInheritedProps()

clearModifyStatus

void clearModifyStatus()