AdService (Cyclos 4.6 WS API Documentation)

All Superinterfaces:

CRUDService<BasicAdDTO,AdDetailsData,AdDataParams>, Service
```
public interface AdService
extends CRUDService<BasicAdDTO,AdDetailsData,AdDataParams>
```
Service interface for advertisements

Author:

micael

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AdSearchData`	`getAdSearchData(AdType type, boolean overBrokeredUsers)` Returns data for searching advertisements
`UserAdsSearchData`	`getUserAdsSearchData(UserLocatorVO locator, AdType type)` Returns data for searching advertisements
`AdViewData`	`getViewData(java.lang.Long id)` Returns data for viewing details of an advertisement
`BasicAdVO`	`loadVO(java.lang.Long id)` Loads a VO, by id
`Page<BasicAdVO>`	`search(BasicAdQuery params)` Searches for advertisements, according to the given query parameters
`void`	`setAsDraft(java.lang.Long id, java.lang.String comments)` Sets the ad back to draft status.
`void`	`setHidden(java.lang.Long id, boolean hidden)` Hides or unhides the ad according to given hidden parameter.

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Method Detail

getAdSearchData

AdSearchData getAdSearchData(AdType type,
                             boolean overBrokeredUsers)
                      throws FrameworkException

Returns data for searching advertisements

Throws:: FrameworkException

getUserAdsSearchData

UserAdsSearchData getUserAdsSearchData(UserLocatorVO locator,
                                       AdType type)
                                throws FrameworkException

Returns data for searching advertisements

Throws:: FrameworkException

getViewData

AdViewData getViewData(java.lang.Long id)
                throws FrameworkException

Returns data for viewing details of an advertisement

Throws:: FrameworkException

loadVO

BasicAdVO loadVO(java.lang.Long id)
          throws FrameworkException

Loads a VO, by id

Throws:: FrameworkException

search

Page<BasicAdVO> search(BasicAdQuery params)
                throws FrameworkException,
                       QueryParseException

Searches for advertisements, according to the given query parameters

Throws:: FrameworkException; QueryParseException

setAsDraft

void setAsDraft(java.lang.Long id,
                java.lang.String comments)

Sets the ad back to draft status.

setHidden
```
void setHidden(java.lang.Long id,
               boolean hidden)
```
Hides or unhides the ad according to given hidden parameter.

Interface AdService