org.kuali.mobility.admin.service

Interface AdminService

All Known Implementing Classes:

AdminServiceImpl

public interface AdminService

Interface for a contract for administrative tasks

Author:

Kuali Mobility Team (mobility.dev@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteHomeScreenById(long layoutId)
void	deleteToolById(long toolId)
List<HomeScreen>	getAllHomeScreens()
List<Tool>	getAllTools()
HomeScreen	getHomeScreenByAlias(String alias)
HomeScreen	getHomeScreenById(long layoutId)
Tool	getToolById(long toolId)
Long	saveHomeScreen(HomeScreen homeScreen)
Long	saveTool(Tool tool)

Method Detail

getAllHomeScreens

List<HomeScreen> getAllHomeScreens()

Returns:

all defined home screens

getHomeScreenById

HomeScreen getHomeScreenById(long layoutId)

Parameters:

layoutId - the id of the home screen to retrieve

Returns:

the home screen matching the id

getHomeScreenByAlias

HomeScreen getHomeScreenByAlias(String alias)

Parameters:

alias - the alias of the home screen to retrieve

Returns:

the home screen matching the alias

saveHomeScreen

Long saveHomeScreen(HomeScreen homeScreen)

Parameters:

homeScreen - the HomeScreen to save

Returns:

the id of the saved HomeScreen

deleteHomeScreenById

void deleteHomeScreenById(long layoutId)

Parameters:

layoutId - the id of the HomeScreen to delete

getAllTools

List<Tool> getAllTools()

Returns:

all defined Tool objects

saveTool

Long saveTool(Tool tool)

Parameters:

tool - the Tool to save

Returns:

the id of the saved Tool

getToolById

Tool getToolById(long toolId)

Parameters:

toolId - the id of the tool to retrieve

Returns:

the Tool matching the id

deleteToolById

void deleteToolById(long toolId)

Parameters:

toolId - the id of the Tool to delete