org.bimserver.models.store.ServiceDescriptor Maven / Gradle / Ivy
/**
* 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.ServiceDescriptor#getName Name}
* - {@link org.bimserver.models.store.ServiceDescriptor#getUrl Url}
* - {@link org.bimserver.models.store.ServiceDescriptor#getToken Token}
* - {@link org.bimserver.models.store.ServiceDescriptor#getIdentifier Identifier}
* - {@link org.bimserver.models.store.ServiceDescriptor#getNotificationProtocol Notification Protocol}
* - {@link org.bimserver.models.store.ServiceDescriptor#getDescription Description}
* - {@link org.bimserver.models.store.ServiceDescriptor#getTrigger Trigger}
* - {@link org.bimserver.models.store.ServiceDescriptor#isReadRevision Read Revision}
* - {@link org.bimserver.models.store.ServiceDescriptor#getReadExtendedData Read Extended Data}
* - {@link org.bimserver.models.store.ServiceDescriptor#isWriteRevision Write Revision}
* - {@link org.bimserver.models.store.ServiceDescriptor#getWriteExtendedData Write Extended Data}
* - {@link org.bimserver.models.store.ServiceDescriptor#getProviderName Provider Name}
* - {@link org.bimserver.models.store.ServiceDescriptor#getCompanyUrl Company Url}
* - {@link org.bimserver.models.store.ServiceDescriptor#getTokenUrl Token Url}
* - {@link org.bimserver.models.store.ServiceDescriptor#getNewProfileUrl New Profile Url}
* - {@link org.bimserver.models.store.ServiceDescriptor#getRegisterUrl Register Url}
* - {@link org.bimserver.models.store.ServiceDescriptor#getAuthorizeUrl Authorize Url}
*
*
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor()
* @model
* @extends IdEObject
* @generated
*/
public interface ServiceDescriptor 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#getServiceDescriptor_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getName Name}' attribute.
*
*
* @param value the new value of the 'Name' attribute.
* @see #getName()
* @generated
*/
void setName(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#getServiceDescriptor_Url()
* @model
* @generated
*/
String getUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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#getServiceDescriptor_Token()
* @model
* @generated
*/
String getToken();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getToken Token}' attribute.
*
*
* @param value the new value of the 'Token' attribute.
* @see #getToken()
* @generated
*/
void setToken(String value);
/**
* Returns the value of the 'Identifier' attribute.
*
*
* If the meaning of the 'Identifier' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Identifier' attribute.
* @see #setIdentifier(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_Identifier()
* @model
* @generated
*/
String getIdentifier();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getIdentifier Identifier}' attribute.
*
*
* @param value the new value of the 'Identifier' attribute.
* @see #getIdentifier()
* @generated
*/
void setIdentifier(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#getServiceDescriptor_NotificationProtocol()
* @model
* @generated
*/
AccessMethod getNotificationProtocol();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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#getServiceDescriptor_Description()
* @model
* @generated
*/
String getDescription();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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#getServiceDescriptor_Trigger()
* @model
* @generated
*/
Trigger getTrigger();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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#getServiceDescriptor_ReadRevision()
* @model
* @generated
*/
boolean isReadRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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' attribute.
*
*
* If the meaning of the 'Read Extended Data' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Read Extended Data' attribute.
* @see #setReadExtendedData(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_ReadExtendedData()
* @model
* @generated
*/
String getReadExtendedData();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getReadExtendedData Read Extended Data}' attribute.
*
*
* @param value the new value of the 'Read Extended Data' attribute.
* @see #getReadExtendedData()
* @generated
*/
void setReadExtendedData(String value);
/**
* Returns the value of the 'Write Revision' attribute.
*
*
* If the meaning of the 'Write Revision' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Write Revision' attribute.
* @see #setWriteRevision(boolean)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_WriteRevision()
* @model
* @generated
*/
boolean isWriteRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#isWriteRevision Write Revision}' attribute.
*
*
* @param value the new value of the 'Write Revision' attribute.
* @see #isWriteRevision()
* @generated
*/
void setWriteRevision(boolean value);
/**
* Returns the value of the 'Write Extended Data' attribute.
*
*
* If the meaning of the 'Write Extended Data' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Write Extended Data' attribute.
* @see #setWriteExtendedData(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_WriteExtendedData()
* @model
* @generated
*/
String getWriteExtendedData();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getWriteExtendedData Write Extended Data}' attribute.
*
*
* @param value the new value of the 'Write Extended Data' attribute.
* @see #getWriteExtendedData()
* @generated
*/
void setWriteExtendedData(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#getServiceDescriptor_ProviderName()
* @model
* @generated
*/
String getProviderName();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#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 'Company Url' attribute.
*
*
* If the meaning of the 'Company Url' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Company Url' attribute.
* @see #setCompanyUrl(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_CompanyUrl()
* @model
* @generated
*/
String getCompanyUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getCompanyUrl Company Url}' attribute.
*
*
* @param value the new value of the 'Company Url' attribute.
* @see #getCompanyUrl()
* @generated
*/
void setCompanyUrl(String value);
/**
* Returns the value of the 'Token Url' attribute.
*
*
* If the meaning of the 'Token Url' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Token Url' attribute.
* @see #setTokenUrl(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_TokenUrl()
* @model
* @generated
*/
String getTokenUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getTokenUrl Token Url}' attribute.
*
*
* @param value the new value of the 'Token Url' attribute.
* @see #getTokenUrl()
* @generated
*/
void setTokenUrl(String value);
/**
* Returns the value of the 'New Profile Url' attribute.
*
*
* If the meaning of the 'New Profile Url' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'New Profile Url' attribute.
* @see #setNewProfileUrl(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_NewProfileUrl()
* @model
* @generated
*/
String getNewProfileUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getNewProfileUrl New Profile Url}' attribute.
*
*
* @param value the new value of the 'New Profile Url' attribute.
* @see #getNewProfileUrl()
* @generated
*/
void setNewProfileUrl(String value);
/**
* Returns the value of the 'Register Url' attribute.
*
*
* If the meaning of the 'Register Url' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Register Url' attribute.
* @see #setRegisterUrl(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_RegisterUrl()
* @model
* @generated
*/
String getRegisterUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getRegisterUrl Register Url}' attribute.
*
*
* @param value the new value of the 'Register Url' attribute.
* @see #getRegisterUrl()
* @generated
*/
void setRegisterUrl(String value);
/**
* Returns the value of the 'Authorize Url' attribute.
*
*
* If the meaning of the 'Authorize Url' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Authorize Url' attribute.
* @see #setAuthorizeUrl(String)
* @see org.bimserver.models.store.StorePackage#getServiceDescriptor_AuthorizeUrl()
* @model
* @generated
*/
String getAuthorizeUrl();
/**
* Sets the value of the '{@link org.bimserver.models.store.ServiceDescriptor#getAuthorizeUrl Authorize Url}' attribute.
*
*
* @param value the new value of the 'Authorize Url' attribute.
* @see #getAuthorizeUrl()
* @generated
*/
void setAuthorizeUrl(String value);
} // ServiceDescriptor