org.bimserver.models.store

Interface Service

All Superinterfaces:

org.eclipse.emf.ecore.EObject, IdEObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

ServiceImpl

public interface Service
extends IdEObject

A representation of the model object 'Service'.

The following features are supported:

• Name
• Service Name
• Service Identifier
• Provider Name
• Url
• Token
• Notification Protocol
• Description
• Trigger
• Read Revision
• Read Extended Data
• Write Revision
• Write Extended Data
• Profile Identifier
• Profile Name
• Profile Description
• Profile Public
• Project
• User
• Internal Service
• Model Checkers

See Also:

StorePackage.getService()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the value of the 'Description' attribute.
InternalServicePluginConfiguration	getInternalService() Returns the value of the 'Internal Service' reference.
org.eclipse.emf.common.util.EList<ModelCheckerInstance>	getModelCheckers() Returns the value of the 'Model Checkers' reference list.
String	getName() Returns the value of the 'Name' attribute.
AccessMethod	getNotificationProtocol() Returns the value of the 'Notification Protocol' attribute.
String	getProfileDescription() Returns the value of the 'Profile Description' attribute.
String	getProfileIdentifier() Returns the value of the 'Profile Identifier' attribute.
String	getProfileName() Returns the value of the 'Profile Name' attribute.
Project	getProject() Returns the value of the 'Project' reference.
String	getProviderName() Returns the value of the 'Provider Name' attribute.
ExtendedDataSchema	getReadExtendedData() Returns the value of the 'Read Extended Data' reference.
String	getServiceIdentifier() Returns the value of the 'Service Identifier' attribute.
String	getServiceName() Returns the value of the 'Service Name' attribute.
String	getToken() Returns the value of the 'Token' attribute.
Trigger	getTrigger() Returns the value of the 'Trigger' attribute.
String	getUrl() Returns the value of the 'Url' attribute.
User	getUser() Returns the value of the 'User' reference.
ExtendedDataSchema	getWriteExtendedData() Returns the value of the 'Write Extended Data' reference.
Project	getWriteRevision() Returns the value of the 'Write Revision' reference.
boolean	isProfilePublic() Returns the value of the 'Profile Public' attribute.
boolean	isReadRevision() Returns the value of the 'Read Revision' attribute.
void	setDescription(String value) Sets the value of the 'Description' attribute.
void	setInternalService(InternalServicePluginConfiguration value) Sets the value of the 'Internal Service' reference.
void	setName(String value) Sets the value of the 'Name' attribute.
void	setNotificationProtocol(AccessMethod value) Sets the value of the 'Notification Protocol' attribute.
void	setProfileDescription(String value) Sets the value of the 'Profile Description' attribute.
void	setProfileIdentifier(String value) Sets the value of the 'Profile Identifier' attribute.
void	setProfileName(String value) Sets the value of the 'Profile Name' attribute.
void	setProfilePublic(boolean value) Sets the value of the 'Profile Public' attribute.
void	setProject(Project value) Sets the value of the 'Project' reference.
void	setProviderName(String value) Sets the value of the 'Provider Name' attribute.
void	setReadExtendedData(ExtendedDataSchema value) Sets the value of the 'Read Extended Data' reference.
void	setReadRevision(boolean value) Sets the value of the 'Read Revision' attribute.
void	setServiceIdentifier(String value) Sets the value of the 'Service Identifier' attribute.
void	setServiceName(String value) Sets the value of the 'Service Name' attribute.
void	setToken(String value) Sets the value of the 'Token' attribute.
void	setTrigger(Trigger value) Sets the value of the 'Trigger' attribute.
void	setUrl(String value) Sets the value of the 'Url' attribute.
void	setUser(User value) Sets the value of the 'User' reference.
void	setWriteExtendedData(ExtendedDataSchema value) Sets the value of the 'Write Extended Data' reference.
void	setWriteRevision(Project value) Sets the value of the 'Write Revision' reference.

Methods inherited from interface org.bimserver.emf.IdEObject

forceLoad, getExpressId, getOid, getPid, getRid, isLoadedOrLoading, load, remove

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

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

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

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getName

String getName()

Returns the value of the 'Name' attribute.

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

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), StorePackage.getService_Name()

setName

void setName(String value)

Sets the value of the 'Name' attribute.

Parameters:

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

See Also:

getName()

getServiceName

String getServiceName()

Returns the value of the 'Service Name' attribute.

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

Returns:

the value of the 'Service Name' attribute.

See Also:

setServiceName(String), StorePackage.getService_ServiceName()

setServiceName

void setServiceName(String value)

Sets the value of the 'Service Name' attribute.

Parameters:

value - the new value of the 'Service Name' attribute.

See Also:

getServiceName()

getServiceIdentifier

String getServiceIdentifier()

Returns the value of the 'Service Identifier' attribute.

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

Returns:

the value of the 'Service Identifier' attribute.

See Also:

setServiceIdentifier(String), StorePackage.getService_ServiceIdentifier()

setServiceIdentifier

void setServiceIdentifier(String value)

Sets the value of the 'Service Identifier' attribute.

Parameters:

value - the new value of the 'Service Identifier' attribute.

See Also:

getServiceIdentifier()

getProviderName

String getProviderName()

Returns the value of the 'Provider Name' attribute.

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

Returns:

the value of the 'Provider Name' attribute.

See Also:

setProviderName(String), StorePackage.getService_ProviderName()

setProviderName

void setProviderName(String value)

Sets the value of the 'Provider Name' attribute.

Parameters:

value - the new value of the 'Provider Name' attribute.

See Also:

getProviderName()

getUrl

String getUrl()

Returns the value of the 'Url' attribute.

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

Returns:

the value of the 'Url' attribute.

See Also:

setUrl(String), StorePackage.getService_Url()

setUrl

void setUrl(String value)

Sets the value of the 'Url' attribute.

Parameters:

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

See Also:

getUrl()

getToken

String getToken()

Returns the value of the 'Token' attribute.

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

Returns:

the value of the 'Token' attribute.

See Also:

setToken(String), StorePackage.getService_Token()

setToken

void setToken(String value)

Sets the value of the 'Token' attribute.

Parameters:

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

See Also:

getToken()

getNotificationProtocol

AccessMethod getNotificationProtocol()

Returns the value of the 'Notification Protocol' attribute. The literals are from the enumeration AccessMethod.

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

Returns:

the value of the 'Notification Protocol' attribute.

See Also:

AccessMethod, setNotificationProtocol(AccessMethod), StorePackage.getService_NotificationProtocol()

setNotificationProtocol

void setNotificationProtocol(AccessMethod value)

Sets the value of the 'Notification Protocol' attribute.

Parameters:

value - the new value of the 'Notification Protocol' attribute.

See Also:

AccessMethod, getNotificationProtocol()

getDescription

String getDescription()

Returns the value of the 'Description' attribute.

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

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String), StorePackage.getService_Description()

setDescription

void setDescription(String value)

Sets the value of the 'Description' attribute.

Parameters:

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

See Also:

getDescription()

getTrigger

Trigger getTrigger()

Returns the value of the 'Trigger' attribute. The literals are from the enumeration Trigger.

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

Returns:

the value of the 'Trigger' attribute.

See Also:

Trigger, setTrigger(Trigger), StorePackage.getService_Trigger()

setTrigger

void setTrigger(Trigger value)

Sets the value of the 'Trigger' attribute.

Parameters:

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

See Also:

Trigger, getTrigger()

isReadRevision

boolean isReadRevision()

Returns the value of the 'Read Revision' attribute.

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

Returns:

the value of the 'Read Revision' attribute.

See Also:

setReadRevision(boolean), StorePackage.getService_ReadRevision()

setReadRevision

void setReadRevision(boolean value)

Sets the value of the 'Read Revision' attribute.

Parameters:

value - the new value of the 'Read Revision' attribute.

See Also:

isReadRevision()

getReadExtendedData

ExtendedDataSchema getReadExtendedData()

Returns the value of the 'Read Extended Data' reference.

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

Returns:

the value of the 'Read Extended Data' reference.

See Also:

setReadExtendedData(ExtendedDataSchema), StorePackage.getService_ReadExtendedData()

setReadExtendedData

void setReadExtendedData(ExtendedDataSchema value)

Sets the value of the 'Read Extended Data' reference.

Parameters:

value - the new value of the 'Read Extended Data' reference.

See Also:

getReadExtendedData()

getWriteRevision

Project getWriteRevision()

Returns the value of the 'Write Revision' reference.

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

Returns:

the value of the 'Write Revision' reference.

See Also:

setWriteRevision(Project), StorePackage.getService_WriteRevision()

setWriteRevision

void setWriteRevision(Project value)

Sets the value of the 'Write Revision' reference.

Parameters:

value - the new value of the 'Write Revision' reference.

See Also:

getWriteRevision()

getWriteExtendedData

ExtendedDataSchema getWriteExtendedData()

Returns the value of the 'Write Extended Data' reference.

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

Returns:

the value of the 'Write Extended Data' reference.

See Also:

setWriteExtendedData(ExtendedDataSchema), StorePackage.getService_WriteExtendedData()

setWriteExtendedData

void setWriteExtendedData(ExtendedDataSchema value)

Sets the value of the 'Write Extended Data' reference.

Parameters:

value - the new value of the 'Write Extended Data' reference.

See Also:

getWriteExtendedData()

getProfileIdentifier

String getProfileIdentifier()

Returns the value of the 'Profile Identifier' attribute.

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

Returns:

the value of the 'Profile Identifier' attribute.

See Also:

setProfileIdentifier(String), StorePackage.getService_ProfileIdentifier()

setProfileIdentifier

void setProfileIdentifier(String value)

Sets the value of the 'Profile Identifier' attribute.

Parameters:

value - the new value of the 'Profile Identifier' attribute.

See Also:

getProfileIdentifier()

getProfileName

String getProfileName()

Returns the value of the 'Profile Name' attribute.

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

Returns:

the value of the 'Profile Name' attribute.

See Also:

setProfileName(String), StorePackage.getService_ProfileName()

setProfileName

void setProfileName(String value)

Sets the value of the 'Profile Name' attribute.

Parameters:

value - the new value of the 'Profile Name' attribute.

See Also:

getProfileName()

getProfileDescription

String getProfileDescription()

Returns the value of the 'Profile Description' attribute.

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

Returns:

the value of the 'Profile Description' attribute.

See Also:

setProfileDescription(String), StorePackage.getService_ProfileDescription()

setProfileDescription

void setProfileDescription(String value)

Sets the value of the 'Profile Description' attribute.

Parameters:

value - the new value of the 'Profile Description' attribute.

See Also:

getProfileDescription()

isProfilePublic

boolean isProfilePublic()

Returns the value of the 'Profile Public' attribute.

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

Returns:

the value of the 'Profile Public' attribute.

See Also:

setProfilePublic(boolean), StorePackage.getService_ProfilePublic()

setProfilePublic

void setProfilePublic(boolean value)

Sets the value of the 'Profile Public' attribute.

Parameters:

value - the new value of the 'Profile Public' attribute.

See Also:

isProfilePublic()

getProject

Project getProject()

Returns the value of the 'Project' reference. It is bidirectional and its opposite is 'Services'.

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

Returns:

the value of the 'Project' reference.

See Also:

setProject(Project), StorePackage.getService_Project(), Project.getServices()

setProject

void setProject(Project value)

Sets the value of the 'Project' reference.

Parameters:

value - the new value of the 'Project' reference.

See Also:

getProject()

getUser

User getUser()

Returns the value of the 'User' reference. It is bidirectional and its opposite is 'Services'.

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

Returns:

the value of the 'User' reference.

See Also:

setUser(User), StorePackage.getService_User(), User.getServices()

setUser

void setUser(User value)

Sets the value of the 'User' reference.

Parameters:

value - the new value of the 'User' reference.

See Also:

getUser()

getInternalService

InternalServicePluginConfiguration getInternalService()

Returns the value of the 'Internal Service' reference.

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

Returns:

the value of the 'Internal Service' reference.

See Also:

setInternalService(InternalServicePluginConfiguration), StorePackage.getService_InternalService()

setInternalService

void setInternalService(InternalServicePluginConfiguration value)

Sets the value of the 'Internal Service' reference.

Parameters:

value - the new value of the 'Internal Service' reference.

See Also:

getInternalService()

getModelCheckers

org.eclipse.emf.common.util.EList<ModelCheckerInstance> getModelCheckers()

Returns the value of the 'Model Checkers' reference list. The list contents are of type ModelCheckerInstance.

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

Returns:

the value of the 'Model Checkers' reference list.

See Also:

StorePackage.getService_ModelCheckers()