edu.iu.iv.modeling.tarl.input
Interface AuthorParameters

All Known Implementing Classes:
DefaultAuthorParameters

public interface AuthorParameters

This interface defines the Parameters for the AuthorManager module of Tarl. These parameters are used only by the AuthorManager module.

Author:
Jeegar T Maru
See Also:
ExecuterParameters

Method Summary
 int getMaximumAge()
          Returns the maximum age of the Authors
 int getNumCoAuthors()
          Returns the number of co-authors for each Author
 int getNumDeactivationAuthors()
          Returns the number of Authors to be deactivated in numDeactivationYears years
 int getNumDeactivationYears()
          Returns the number of years in which deactivation is supposed to take place
 void initializeDefault()
          Initializes the AuthorParameters with default values
 void setMaximumAge(int maximumAge)
          Stores the maximum age of the Authors
 void setNumCoAuthors(int numCoAuthors)
          Stores the number of co-authors for each Author
 void setNumDeactivationAuthors(int numDeactivationAuthors)
          Stores the number of Authors to be deactivated in numDeactivationYears years
 void setNumDeactivationYears(int numDeactivationYears)
          Stores the number of years in which deactivation is supposed to take place
 

Method Detail

initializeDefault

public void initializeDefault()
Initializes the AuthorParameters with default values


getMaximumAge

public int getMaximumAge()
Returns the maximum age of the Authors

Returns:
the maximum age of the authors

getNumDeactivationAuthors

public int getNumDeactivationAuthors()
Returns the number of Authors to be deactivated in numDeactivationYears years

Returns:
the number of authors to be deactivate in numDeactivationYears years

getNumDeactivationYears

public int getNumDeactivationYears()
Returns the number of years in which deactivation is supposed to take place

Returns:
the number of years in which deactivation is supposed to take place

getNumCoAuthors

public int getNumCoAuthors()
Returns the number of co-authors for each Author

Returns:
the number of co-authors for each author

setMaximumAge

public void setMaximumAge(int maximumAge)
                   throws TarlException
Stores the maximum age of the Authors

Parameters:
maximumAge - the maximum age of the authors
Throws:
TarlException - if the field is set with an invalid value

setNumDeactivationAuthors

public void setNumDeactivationAuthors(int numDeactivationAuthors)
                               throws TarlException
Stores the number of Authors to be deactivated in numDeactivationYears years

Parameters:
numDeactivationAuthors - the number of authors to be deactivate in numDeactivationYears years
Throws:
TarlException - if the field is set with an invalid value

setNumDeactivationYears

public void setNumDeactivationYears(int numDeactivationYears)
                             throws TarlException
Stores the number of years in which deactivation is supposed to take place

Parameters:
numDeactivationYears - the number of years in which deactivation is supposed to take place
Throws:
TarlException - if the field is set with an invalid value

setNumCoAuthors

public void setNumCoAuthors(int numCoAuthors)
                     throws TarlException
Stores the number of co-authors for each Author

Parameters:
numCoAuthors - the number of co-authors for each author
Throws:
TarlException - if the field is set with an invalid value