| String loginWithGUID(String clientGUID) |
| Performs a login into the news item repository. |
| Parameters |
|
|
| Returns: |
| login On success a session token is returned. |
| Exceptions: |
|
If the news service abonnement is not found, an exception is raised.
|
|
| boolean isValid(String token) |
| Determines if a session is valid. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
|
| Returns: |
| true if the session token is valid, false otherwise. |
| Exceptions: |
|
None.
|
|
| long createNewsItem(String token,String title) |
| Creates a new news item with the given title. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| title | String | The title of the new news item. |
|
| Returns: |
| a unique ID which is used by some methods of this class. |
| Exceptions: |
|
If the session token is not valid, an exception is thrown (A SOAP Fault is returned).
|
|
| String deleteNewsItem(String token,long newsID) |
| Deletes a news item. |
| Parameters |
| name | type | Description |
| token | String | the session token which can be obtained from the login funktion. |
| newsID | long | the newsID of the item to be deleted |
|
| Returns: |
| On success an empty string is returned. |
| Exceptions: |
|
If the session token is not valid, an exception is thrown (A SOAP Fault is returned).
|
|
| String getCurrentNewsItemListWithClientGUID(String clientGUID) |
| Retrieves a list of the current valid news items as XML string. A news item is valid if
it is published and the point in time this method is invoked is between the start date and the end date.
This method is stateless. You can specify your registration key to obtain the news items. |
| Parameters |
|
|
| Returns: |
| the news item list as xml string. |
| Exceptions: |
|
If the session token is not valid, an exception is thrown (A SOAP Fault is returned).
|
|
| String getNewsItemWithClientGUID(String clientGUID,long newsID) |
| Retrieves an XML representation of the news item of the given ID.
This method is stateless. You can specify your registration key to obtain the news items. |
| Parameters |
| name | type | Description |
| clientGUID | String | the registration key, which can be obtained by registering on 7Services Registration Site |
| newsID | long | The newsID of the item to be retrieved. |
|
| Returns: |
| the xml representation of the news item as string |
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String getNewsItem(String token,long newsID) |
| Retrieves an XML representation of the news item of the given ID. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
|
| Returns: |
| the xml representation of the news item as string |
| Exceptions: |
|
If the session token is not valid, an exception is thrown (A SOAP Fault is returned).
|
|
| String getNewsItemField(String token,long newsID,String dataGroup,String fieldName) |
Retrieves a field of the news item. The attributes of a news item are organized in groups.
Currently the following attributes are supported:
| dataGroup | fieldName | description |
| Descriptive | Title | The title of the news |
| Descriptive | Headline | The head line of the news item |
| Descriptive | Subheadline | The subheadline of the news item |
| Descriptive | Teaser | a teaser text for the news item |
| Descriptive | Body | the body of the news item |
| Validity | Start | the start date of the news to be marked as valid as ISO-String |
| Validity | End | the end date of the news to be marked as valid as ISO-String |
| Administrative | State | the state of the news given as string. The NewsConsumerWS webservice shows only those news which are valid and have the state 'Published'. |
|
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
| dataGroup | String | The dataGroup of the given field |
| fieldName | String | The name of the given field |
|
| Returns: |
| the news field as string. If the dataGroup or the field is not found an empty string is returned. |
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String getNewsItemList(String token) |
| Retrieves a list of news item as XML string. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
|
| Returns: |
| the news item list as xml string |
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String setEndDate(String token,long newsID,String date) |
| Does the same as updateNewsItemField(token,newsID,"Validity","End",date), see below. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
| date | String | The end date as ISO-Date string |
|
| Returns: |
|
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String setNewsItemState(String token,long newsID,String state) |
| Does the same as updateNewsItemField(token,newsID,"Administrative","State",date), see below. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
| state | String | |
|
| Returns: |
|
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String setStartDate(String token,long newsID,String date) |
| Does the same as updateNewsItemField(token,newsID,"Validity","Start",date), see below. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
| date | String | The start date as ISO-Date string |
|
| Returns: |
|
| Exceptions: |
|
an exception if the session token is not valid.
|
|
| String updateNewsItemField(String token,long newsID,String dataGroup,String fieldName,String value) |
| Updates a news item field. For the supported fields see the documentation of getNewsItemField. |
| Parameters |
| name | type | Description |
| token | String | The session token which can be obtained from the login funktion. |
| newsID | long | The newsID of the item to be deleted |
| dataGroup | String | The dataGroup of the given field |
| fieldName | String | The name of the given field |
| value | String | The new value of the field |
|
| Returns: |
| the news field as string. if the dataGroup or the field is not found an empty string is returned. |
| Exceptions: |
|
an exception if the session token is not valid.
|
|
