org.bimserver.models.store.Service Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation
Show all versions of PluginBase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
/**
* Copyright (C) 2009-2014 BIMserver.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see
* The following features are supported:
*
*
* - {@link org.bimserver.models.store.Service#getName Name}
* - {@link org.bimserver.models.store.Service#getServiceName Service Name}
* - {@link org.bimserver.models.store.Service#getServiceIdentifier Service Identifier}
* - {@link org.bimserver.models.store.Service#getProviderName Provider Name}
* - {@link org.bimserver.models.store.Service#getUrl Url}
* - {@link org.bimserver.models.store.Service#getToken Token}
* - {@link org.bimserver.models.store.Service#getNotificationProtocol Notification Protocol}
* - {@link org.bimserver.models.store.Service#getDescription Description}
* - {@link org.bimserver.models.store.Service#getTrigger Trigger}
* - {@link org.bimserver.models.store.Service#isReadRevision Read Revision}
* - {@link org.bimserver.models.store.Service#getReadExtendedData Read Extended Data}
* - {@link org.bimserver.models.store.Service#getWriteRevision Write Revision}
* - {@link org.bimserver.models.store.Service#getWriteExtendedData Write Extended Data}
* - {@link org.bimserver.models.store.Service#getProfileIdentifier Profile Identifier}
* - {@link org.bimserver.models.store.Service#getProfileName Profile Name}
* - {@link org.bimserver.models.store.Service#getProfileDescription Profile Description}
* - {@link org.bimserver.models.store.Service#isProfilePublic Profile Public}
* - {@link org.bimserver.models.store.Service#getProject Project}
* - {@link org.bimserver.models.store.Service#getUser User}
* - {@link org.bimserver.models.store.Service#getInternalService Internal Service}
* - {@link org.bimserver.models.store.Service#getModelCheckers Model Checkers}
*
*
* @see org.bimserver.models.store.StorePackage#getService()
* @model
* @extends IdEObject
* @generated
*/
public interface Service extends IdEObject {
/**
* 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...
*
*
* @return the value of the 'Name' attribute.
* @see #setName(String)
* @see org.bimserver.models.store.StorePackage#getService_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getName Name}' attribute.
*
*
* @param value the new value of the 'Name' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* 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...
*
*
* @return the value of the 'Service Name' attribute.
* @see #setServiceName(String)
* @see org.bimserver.models.store.StorePackage#getService_ServiceName()
* @model
* @generated
*/
String getServiceName();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getServiceName Service Name}' attribute.
*
*
* @param value the new value of the 'Service Name' attribute.
* @see #getServiceName()
* @generated
*/
void setServiceName(String value);
/**
* 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...
*
*
* @return the value of the 'Service Identifier' attribute.
* @see #setServiceIdentifier(String)
* @see org.bimserver.models.store.StorePackage#getService_ServiceIdentifier()
* @model
* @generated
*/
String getServiceIdentifier();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getServiceIdentifier Service Identifier}' attribute.
*
*
* @param value the new value of the 'Service Identifier' attribute.
* @see #getServiceIdentifier()
* @generated
*/
void setServiceIdentifier(String value);
/**
* 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...
*
*
* @return the value of the 'Provider Name' attribute.
* @see #setProviderName(String)
* @see org.bimserver.models.store.StorePackage#getService_ProviderName()
* @model
* @generated
*/
String getProviderName();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getProviderName Provider Name}' attribute.
*
*
* @param value the new value of the 'Provider Name' attribute.
* @see #getProviderName()
* @generated
*/
void setProviderName(String value);
/**
* 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...
*
*
* @return the value of the 'Url' attribute.
* @see #setUrl(String)
* @see org.bimserver.models.store.StorePackage#getService_Url()
* @model
* @generated
*/
String getUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getUrl Url}' attribute.
*
*
* @param value the new value of the 'Url' attribute.
* @see #getUrl()
* @generated
*/
void setUrl(String value);
/**
* 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...
*
*
* @return the value of the 'Token' attribute.
* @see #setToken(String)
* @see org.bimserver.models.store.StorePackage#getService_Token()
* @model
* @generated
*/
String getToken();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getToken Token}' attribute.
*
*
* @param value the new value of the 'Token' attribute.
* @see #getToken()
* @generated
*/
void setToken(String value);
/**
* Returns the value of the 'Notification Protocol' attribute.
* The literals are from the enumeration {@link org.bimserver.models.log.AccessMethod}.
*
*
* If the meaning of the 'Notification Protocol' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Notification Protocol' attribute.
* @see org.bimserver.models.log.AccessMethod
* @see #setNotificationProtocol(AccessMethod)
* @see org.bimserver.models.store.StorePackage#getService_NotificationProtocol()
* @model
* @generated
*/
AccessMethod getNotificationProtocol();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getNotificationProtocol Notification Protocol}' attribute.
*
*
* @param value the new value of the 'Notification Protocol' attribute.
* @see org.bimserver.models.log.AccessMethod
* @see #getNotificationProtocol()
* @generated
*/
void setNotificationProtocol(AccessMethod value);
/**
* 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...
*
*
* @return the value of the 'Description' attribute.
* @see #setDescription(String)
* @see org.bimserver.models.store.StorePackage#getService_Description()
* @model
* @generated
*/
String getDescription();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getDescription Description}' attribute.
*
*
* @param value the new value of the 'Description' attribute.
* @see #getDescription()
* @generated
*/
void setDescription(String value);
/**
* Returns the value of the 'Trigger' attribute.
* The literals are from the enumeration {@link org.bimserver.models.store.Trigger}.
*
*
* If the meaning of the 'Trigger' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Trigger' attribute.
* @see org.bimserver.models.store.Trigger
* @see #setTrigger(Trigger)
* @see org.bimserver.models.store.StorePackage#getService_Trigger()
* @model
* @generated
*/
Trigger getTrigger();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getTrigger Trigger}' attribute.
*
*
* @param value the new value of the 'Trigger' attribute.
* @see org.bimserver.models.store.Trigger
* @see #getTrigger()
* @generated
*/
void setTrigger(Trigger value);
/**
* 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...
*
*
* @return the value of the 'Read Revision' attribute.
* @see #setReadRevision(boolean)
* @see org.bimserver.models.store.StorePackage#getService_ReadRevision()
* @model
* @generated
*/
boolean isReadRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#isReadRevision Read Revision}' attribute.
*
*
* @param value the new value of the 'Read Revision' attribute.
* @see #isReadRevision()
* @generated
*/
void setReadRevision(boolean value);
/**
* 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...
*
*
* @return the value of the 'Read Extended Data' reference.
* @see #setReadExtendedData(ExtendedDataSchema)
* @see org.bimserver.models.store.StorePackage#getService_ReadExtendedData()
* @model
* @generated
*/
ExtendedDataSchema getReadExtendedData();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getReadExtendedData Read Extended Data}' reference.
*
*
* @param value the new value of the 'Read Extended Data' reference.
* @see #getReadExtendedData()
* @generated
*/
void setReadExtendedData(ExtendedDataSchema value);
/**
* 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...
*
*
* @return the value of the 'Write Revision' reference.
* @see #setWriteRevision(Project)
* @see org.bimserver.models.store.StorePackage#getService_WriteRevision()
* @model
* @generated
*/
Project getWriteRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getWriteRevision Write Revision}' reference.
*
*
* @param value the new value of the 'Write Revision' reference.
* @see #getWriteRevision()
* @generated
*/
void setWriteRevision(Project value);
/**
* 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...
*
*
* @return the value of the 'Write Extended Data' reference.
* @see #setWriteExtendedData(ExtendedDataSchema)
* @see org.bimserver.models.store.StorePackage#getService_WriteExtendedData()
* @model
* @generated
*/
ExtendedDataSchema getWriteExtendedData();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getWriteExtendedData Write Extended Data}' reference.
*
*
* @param value the new value of the 'Write Extended Data' reference.
* @see #getWriteExtendedData()
* @generated
*/
void setWriteExtendedData(ExtendedDataSchema value);
/**
* 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...
*
*
* @return the value of the 'Profile Identifier' attribute.
* @see #setProfileIdentifier(String)
* @see org.bimserver.models.store.StorePackage#getService_ProfileIdentifier()
* @model
* @generated
*/
String getProfileIdentifier();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getProfileIdentifier Profile Identifier}' attribute.
*
*
* @param value the new value of the 'Profile Identifier' attribute.
* @see #getProfileIdentifier()
* @generated
*/
void setProfileIdentifier(String value);
/**
* 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...
*
*
* @return the value of the 'Profile Name' attribute.
* @see #setProfileName(String)
* @see org.bimserver.models.store.StorePackage#getService_ProfileName()
* @model
* @generated
*/
String getProfileName();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getProfileName Profile Name}' attribute.
*
*
* @param value the new value of the 'Profile Name' attribute.
* @see #getProfileName()
* @generated
*/
void setProfileName(String value);
/**
* 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...
*
*
* @return the value of the 'Profile Description' attribute.
* @see #setProfileDescription(String)
* @see org.bimserver.models.store.StorePackage#getService_ProfileDescription()
* @model
* @generated
*/
String getProfileDescription();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getProfileDescription Profile Description}' attribute.
*
*
* @param value the new value of the 'Profile Description' attribute.
* @see #getProfileDescription()
* @generated
*/
void setProfileDescription(String value);
/**
* 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...
*
*
* @return the value of the 'Profile Public' attribute.
* @see #setProfilePublic(boolean)
* @see org.bimserver.models.store.StorePackage#getService_ProfilePublic()
* @model
* @generated
*/
boolean isProfilePublic();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#isProfilePublic Profile Public}' attribute.
*
*
* @param value the new value of the 'Profile Public' attribute.
* @see #isProfilePublic()
* @generated
*/
void setProfilePublic(boolean value);
/**
* Returns the value of the 'Project' reference.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Project#getServices Services}'.
*
*
* If the meaning of the 'Project' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Project' reference.
* @see #setProject(Project)
* @see org.bimserver.models.store.StorePackage#getService_Project()
* @see org.bimserver.models.store.Project#getServices
* @model opposite="services"
* @generated
*/
Project getProject();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getProject Project}' reference.
*
*
* @param value the new value of the 'Project' reference.
* @see #getProject()
* @generated
*/
void setProject(Project value);
/**
* Returns the value of the 'User' reference.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.User#getServices Services}'.
*
*
* If the meaning of the 'User' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'User' reference.
* @see #setUser(User)
* @see org.bimserver.models.store.StorePackage#getService_User()
* @see org.bimserver.models.store.User#getServices
* @model opposite="services"
* @generated
*/
User getUser();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getUser User}' reference.
*
*
* @param value the new value of the 'User' reference.
* @see #getUser()
* @generated
*/
void setUser(User value);
/**
* 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...
*
*
* @return the value of the 'Internal Service' reference.
* @see #setInternalService(InternalServicePluginConfiguration)
* @see org.bimserver.models.store.StorePackage#getService_InternalService()
* @model
* @generated
*/
InternalServicePluginConfiguration getInternalService();
/**
* Sets the value of the '{@link org.bimserver.models.store.Service#getInternalService Internal Service}' reference.
*
*
* @param value the new value of the 'Internal Service' reference.
* @see #getInternalService()
* @generated
*/
void setInternalService(InternalServicePluginConfiguration value);
/**
* Returns the value of the 'Model Checkers' reference list.
* The list contents are of type {@link org.bimserver.models.store.ModelCheckerInstance}.
*
*
* If the meaning of the 'Model Checkers' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Model Checkers' reference list.
* @see org.bimserver.models.store.StorePackage#getService_ModelCheckers()
* @model
* @generated
*/
EList getModelCheckers();
} // Service
© 2015 - 2025 Weber Informatics LLC | Privacy Policy