Package org.cyclos.services.system

Interface NetworkService

All Superinterfaces:

CRUDService<NetworkDTO,NetworkData,Void>, Service

All Known Subinterfaces:

NetworkServiceLocal

public interface NetworkService
extends CRUDService<NetworkDTO,NetworkData,Void>

Service used to manage networks

Field Summary

Fields

Modifier and Type	Field	Description
static String	GLOBAL_INTERNAL_NAME	Internal name for the "global network" (or global mode)

Method Summary

Modifier and Type	Method	Description
Long	createWithData(@NotNull NetworkDTO network, @NotNull NetworkInitialDataDTO data)	Creates a new network with initial data
NetworkWithInitialDataData	getDataForNewWithData()	Returns data for creating a new network with initial data
NetworkInitialDataDTO	getInitialData(@NotNull BasicNetworkInitialDataDTO basicData)	Returns an initial data pre-populated with fields according to the given initial selections
NetworkSearchData	getSearchData()	Returns data for searching networks
String	resolveNetworkUrl(@NotNull NetworkVO network)	Returns the URL a global admin can use to access the given network
Page<NetworkVO>	search(@NotNull NetworkQuery query)	Searches for networks according to the given criteria

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Field Detail

GLOBAL_INTERNAL_NAME

static final String GLOBAL_INTERNAL_NAME

Internal name for the "global network" (or global mode)

See Also:

Constant Field Values

Method Detail

createWithData

Long createWithData(@NotNull
                    @NotNull NetworkDTO network,
                    @NotNull
                    @NotNull NetworkInitialDataDTO data)
             throws FrameworkException

Creates a new network with initial data

Throws:

FrameworkException

getDataForNewWithData

NetworkWithInitialDataData getDataForNewWithData()
                                          throws FrameworkException

Returns data for creating a new network with initial data

Throws:

FrameworkException

getInitialData

NetworkInitialDataDTO getInitialData(@NotNull
                                     @NotNull BasicNetworkInitialDataDTO basicData)
                              throws FrameworkException

Returns an initial data pre-populated with fields according to the given initial selections

Throws:

FrameworkException

getSearchData

NetworkSearchData getSearchData()
                         throws FrameworkException

Returns data for searching networks

Throws:

FrameworkException

resolveNetworkUrl

String resolveNetworkUrl(@NotNull
                         @NotNull NetworkVO network)
                  throws FrameworkException

Returns the URL a global admin can use to access the given network

Throws:

FrameworkException

search

Page<NetworkVO> search(@NotNull
                       @NotNull NetworkQuery query)
                throws FrameworkException

Searches for networks according to the given criteria

Throws:

FrameworkException